openapi: 3.0.3 info: title: Infisical Admin Secret Syncs API description: List of all available APIs that can be consumed version: 0.0.1 servers: - url: https://us.infisical.com description: Production server (US) - url: https://eu.infisical.com description: Production server (EU) - url: http://localhost:8080 description: Local server tags: - name: Secret Syncs paths: /api/v1/secret-syncs/options: get: operationId: listSecretSyncOptions tags: - Secret Syncs description: List the available Secret Sync Options. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncOptions: type: array items: anyOf: - type: object properties: name: type: string enum: - AWS Parameter Store connection: type: string enum: - aws destination: type: string enum: - aws-parameter-store canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: AWS Parameter Store - type: object properties: name: type: string enum: - AWS Secrets Manager connection: type: string enum: - aws destination: type: string enum: - aws-secrets-manager canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: AWS Secrets Manager - type: object properties: name: type: string enum: - GitHub connection: type: string enum: - github destination: type: string enum: - github canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: GitHub - type: object properties: name: type: string enum: - GCP Secret Manager connection: type: string enum: - gcp destination: type: string enum: - gcp-secret-manager canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: GCP Secret Manager - type: object properties: name: type: string enum: - Azure Key Vault connection: type: string enum: - azure-key-vault destination: type: string enum: - azure-key-vault canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Azure Key Vault - type: object properties: name: type: string enum: - Azure App Configuration connection: type: string enum: - azure-app-configuration destination: type: string enum: - azure-app-configuration canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Azure App Configuration - type: object properties: name: type: string enum: - Azure DevOps connection: type: string enum: - azure-devops destination: type: string enum: - azure-devops canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Azure DevOps - type: object properties: name: type: string enum: - Databricks connection: type: string enum: - databricks destination: type: string enum: - databricks canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Databricks - type: object properties: name: type: string enum: - Humanitec connection: type: string enum: - humanitec destination: type: string enum: - humanitec canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Humanitec - type: object properties: name: type: string enum: - Terraform Cloud connection: type: string enum: - terraform-cloud destination: type: string enum: - terraform-cloud canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Terraform Cloud - type: object properties: name: type: string enum: - Camunda connection: type: string enum: - camunda destination: type: string enum: - camunda canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Camunda - type: object properties: name: type: string enum: - Vercel connection: type: string enum: - vercel destination: type: string enum: - vercel canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Vercel - type: object properties: name: type: string enum: - Windmill connection: type: string enum: - windmill destination: type: string enum: - windmill canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Windmill - type: object properties: name: type: string enum: - Hashicorp Vault connection: type: string enum: - hashicorp-vault destination: type: string enum: - hashicorp-vault canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Hashicorp Vault - type: object properties: name: type: string enum: - TeamCity connection: type: string enum: - teamcity destination: type: string enum: - teamcity canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: TeamCity - type: object properties: name: type: string enum: - OCI Vault connection: type: string enum: - oci destination: type: string enum: - oci-vault canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true enterprise: type: boolean required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion - enterprise additionalProperties: false title: OCI Vault - type: object properties: name: type: string enum: - 1Password connection: type: string enum: - 1password destination: type: string enum: - 1password canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: 1Password - type: object properties: name: type: string enum: - Heroku connection: type: string enum: - heroku destination: type: string enum: - heroku canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Heroku - type: object properties: name: type: string enum: - Render connection: type: string enum: - render destination: type: string enum: - render canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Render - type: object properties: name: type: string enum: - Fly.io connection: type: string enum: - flyio destination: type: string enum: - flyio canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Fly.io - type: object properties: name: type: string enum: - GitLab connection: type: string enum: - gitlab destination: type: string enum: - gitlab canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: GitLab - type: object properties: name: type: string enum: - Cloudflare Pages connection: type: string enum: - cloudflare destination: type: string enum: - cloudflare-pages canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Cloudflare Pages - type: object properties: name: type: string enum: - Cloudflare Workers connection: type: string enum: - cloudflare destination: type: string enum: - cloudflare-workers canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Cloudflare Workers - type: object properties: name: type: string enum: - Digital Ocean App Platform connection: type: string enum: - digital-ocean destination: type: string enum: - digital-ocean-app-platform canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Digital Ocean App Platform - type: object properties: name: type: string enum: - Zabbix connection: type: string enum: - zabbix destination: type: string enum: - zabbix canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Zabbix - type: object properties: name: type: string enum: - Railway connection: type: string enum: - railway destination: type: string enum: - railway canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Railway - type: object properties: name: type: string enum: - Checkly connection: type: string enum: - checkly destination: type: string enum: - checkly canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Checkly - type: object properties: name: type: string enum: - Supabase connection: type: string enum: - supabase destination: type: string enum: - supabase canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Supabase - type: object properties: name: type: string enum: - Netlify connection: type: string enum: - netlify destination: type: string enum: - netlify canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Netlify - type: object properties: name: type: string enum: - Northflank connection: type: string enum: - northflank destination: type: string enum: - northflank canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Northflank - type: object properties: name: type: string enum: - Bitbucket connection: type: string enum: - bitbucket destination: type: string enum: - bitbucket canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Bitbucket - type: object properties: name: type: string enum: - Laravel Forge connection: type: string enum: - laravel-forge destination: type: string enum: - laravel-forge canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Laravel Forge - type: object properties: name: type: string enum: - Chef connection: type: string enum: - chef destination: type: string enum: - chef canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true enterprise: type: boolean required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion - enterprise additionalProperties: false title: Chef - type: object properties: name: type: string enum: - Octopus Deploy connection: type: string enum: - octopus-deploy destination: type: string enum: - octopus-deploy canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Octopus Deploy - type: object properties: name: type: string enum: - CircleCI connection: type: string enum: - circleci destination: type: string enum: - circleci canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: CircleCI - type: object properties: name: type: string enum: - Azure Entra ID SCIM connection: type: string enum: - azure-entra-id destination: type: string enum: - azure-entra-id-scim canImportSecrets: type: boolean enum: - false supportsKeySchema: type: boolean enum: - false supportsDisableSecretDeletion: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - false required: - name - connection - destination - canImportSecrets - supportsKeySchema - supportsDisableSecretDeletion - canRemoveSecretsOnDeletion additionalProperties: false title: Azure Entra ID SCIM - type: object properties: name: type: string enum: - Infisical connection: type: string enum: - external-infisical destination: type: string enum: - external-infisical canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true supportsKeySchema: type: boolean enum: - false required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion - supportsKeySchema additionalProperties: false title: Infisical - type: object properties: name: type: string enum: - OVH connection: type: string enum: - ovh destination: type: string enum: - ovh canImportSecrets: type: boolean enum: - true canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: OVH - type: object properties: name: type: string enum: - Devin connection: type: string enum: - devin destination: type: string enum: - devin canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Devin - type: object properties: name: type: string enum: - Ona connection: type: string enum: - ona destination: type: string enum: - ona canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Ona - type: object properties: name: type: string enum: - Travis CI connection: type: string enum: - travis-ci destination: type: string enum: - travis-ci canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Travis CI - type: object properties: name: type: string enum: - Snowflake connection: type: string enum: - snowflake destination: type: string enum: - snowflake canImportSecrets: type: boolean enum: - false canRemoveSecretsOnDeletion: type: boolean enum: - true required: - name - connection - destination - canImportSecrets - canRemoveSecretsOnDeletion additionalProperties: false title: Snowflake required: - secretSyncOptions additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs: get: operationId: listSecretSyncs tags: - Secret Syncs description: List all the Secret Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Secret Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: anyOf: - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI - type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store: get: operationId: listAwsParameterStoreSecretSyncs tags: - Secret Syncs description: List the AWS Parameter Store Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list AWS Parameter Store Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAwsParameterStoreSecretSync tags: - Secret Syncs description: Create an AWS Parameter Store Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the AWS Parameter Store Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the AWS Parameter Store Sync. connectionId: type: string format: uuid description: The ID of the AWS Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store/{syncId}: get: operationId: getAwsParameterStoreSecretSync tags: - Secret Syncs description: Get the specified AWS Parameter Store Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAwsParameterStoreSecretSync tags: - Secret Syncs description: Update the specified AWS Parameter Store Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the AWS Parameter Store Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the AWS Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the AWS Parameter Store Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAwsParameterStoreSecretSync tags: - Secret Syncs description: Delete the specified AWS Parameter Store Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store/sync-name/{syncName}: get: operationId: getAwsParameterStoreSecretSyncByName tags: - Secret Syncs description: Get the specified AWS Parameter Store Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the AWS Parameter Store Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the AWS Parameter Store Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store/{syncId}/sync-secrets: post: operationId: syncAwsParameterStoreSecretSync tags: - Secret Syncs description: Trigger a sync for the specified AWS Parameter Store Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store/{syncId}/import-secrets: post: operationId: importAwsParameterStoreSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified AWS Parameter Store Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or AWS Parameter Store. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-parameter-store/{syncId}/remove-secrets: post: operationId: removeAwsParameterStoreSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified AWS Parameter Store Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Parameter Store Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Parameter Store destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Parameter Store destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Parameter Store destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional resource tags to add to parameters synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as resource tags to parameters synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-parameter-store destinationConfig: type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. path: type: string minLength: 1 maxLength: 2048 description: The Parameter Store path to sync secrets to. required: - region - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Parameter Store required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager: get: operationId: listAwsSecretsManagerSecretSyncs tags: - Secret Syncs description: List the AWS Secrets Manager Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list AWS Secrets Manager Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAwsSecretsManagerSecretSync tags: - Secret Syncs description: Create an AWS Secrets Manager Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the AWS Secrets Manager Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the AWS Secrets Manager Sync. connectionId: type: string format: uuid description: The ID of the AWS Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager/{syncId}: get: operationId: getAwsSecretsManagerSecretSync tags: - Secret Syncs description: Get the specified AWS Secrets Manager Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAwsSecretsManagerSecretSync tags: - Secret Syncs description: Update the specified AWS Secrets Manager Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the AWS Secrets Manager Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the AWS Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the AWS Secrets Manager Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAwsSecretsManagerSecretSync tags: - Secret Syncs description: Delete the specified AWS Secrets Manager Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager/sync-name/{syncName}: get: operationId: getAwsSecretsManagerSecretSyncByName tags: - Secret Syncs description: Get the specified AWS Secrets Manager Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the AWS Secrets Manager Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the AWS Secrets Manager Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager/{syncId}/sync-secrets: post: operationId: syncAwsSecretsManagerSecretSync tags: - Secret Syncs description: Trigger a sync for the specified AWS Secrets Manager Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager/{syncId}/import-secrets: post: operationId: importAwsSecretsManagerSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified AWS Secrets Manager Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or AWS Secrets Manager. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/aws-secrets-manager/{syncId}/remove-secrets: post: operationId: removeAwsSecretsManagerSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified AWS Secrets Manager Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the AWS Secrets Manager Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the AWS Secrets Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the AWS Secrets Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the AWS Secrets Manager destination when syncing. keyId: type: string minLength: 1 maxLength: 256 description: The AWS KMS key ID or alias to use when encrypting parameters synced by Infisical. tags: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 128 value: type: string maxLength: 256 required: - key - value additionalProperties: false maxItems: 50 description: Optional tags to add to secrets synced by Infisical. syncSecretMetadataAsTags: type: boolean description: Whether Infisical secret metadata should be added as tags to secrets synced by Infisical. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - aws name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - aws-secrets-manager destinationConfig: allOf: - anyOf: - type: object properties: mappingBehavior: type: string enum: - one-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. required: - mappingBehavior additionalProperties: false - type: object properties: mappingBehavior: type: string enum: - many-to-one description: How secrets from Infisical should be mapped to AWS Secrets Manager; one-to-one or many-to-one. secretName: type: string minLength: 1 maxLength: 256 description: The secret name in AWS Secrets Manager to sync to when using mapping behavior many-to-one. required: - mappingBehavior - secretName additionalProperties: false - type: object properties: region: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-east-1 - us-gov-west-1 - af-south-1 - ap-east-1 - ap-south-1 - ap-south-2 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-southeast-3 - ap-southeast-4 - ca-central-1 - eu-central-1 - eu-central-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-south-1 - eu-south-2 - eu-north-1 - me-south-1 - me-central-1 - sa-east-1 description: The AWS region to sync secrets to. required: - region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: AWS Secrets Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github: get: operationId: listGitHubSecretSyncs tags: - Secret Syncs description: List the GitHub Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list GitHub Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createGitHubSecretSync tags: - Secret Syncs description: Create a GitHub Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the GitHub Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the GitHub Sync. connectionId: type: string format: uuid description: The ID of the GitHub Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github/{syncId}: get: operationId: getGitHubSecretSync tags: - Secret Syncs description: Get the specified GitHub Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateGitHubSecretSync tags: - Secret Syncs description: Update the specified GitHub Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the GitHub Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the GitHub Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the GitHub Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteGitHubSecretSync tags: - Secret Syncs description: Delete the specified GitHub Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github/sync-name/{syncName}: get: operationId: getGitHubSecretSyncByName tags: - Secret Syncs description: Get the specified GitHub Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the GitHub Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the GitHub Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github/{syncId}/sync-secrets: post: operationId: syncGitHubSecretSync tags: - Secret Syncs description: Trigger a sync for the specified GitHub Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github/{syncId}/import-secrets: post: operationId: importGitHubSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified GitHub Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or GitHub. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/github/{syncId}/remove-secrets: post: operationId: removeGitHubSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified GitHub Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitHub Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitHub destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitHub destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitHub destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - github name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - github destinationConfig: anyOf: - type: object properties: scope: type: string enum: - organization description: The GitHub scope that secrets should be synced to org: type: string minLength: 1 description: The name of the GitHub organization. visibility: type: string enum: - all - private - selected selectedRepositoryIds: type: array items: type: number required: - scope - org - visibility additionalProperties: false - type: object properties: scope: type: string enum: - repository description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. required: - scope - owner - repo additionalProperties: false - type: object properties: scope: type: string enum: - repository-environment description: The GitHub scope that secrets should be synced to owner: type: string minLength: 1 description: The name of the GitHub account owner of the repository. repo: type: string minLength: 1 description: The name of the GitHub repository. env: type: string minLength: 1 description: The name of the GitHub environment. required: - scope - owner - repo - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitHub required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager: get: operationId: listGcpSecretManagerSecretSyncs tags: - Secret Syncs description: List the GCP Secret Manager Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list GCP Secret Manager Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createGcpSecretManagerSecretSync tags: - Secret Syncs description: Create a GCP Secret Manager Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the GCP Secret Manager Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the GCP Secret Manager Sync. connectionId: type: string format: uuid description: The ID of the GCP Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager/{syncId}: get: operationId: getGcpSecretManagerSecretSync tags: - Secret Syncs description: Get the specified GCP Secret Manager Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateGcpSecretManagerSecretSync tags: - Secret Syncs description: Update the specified GCP Secret Manager Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the GCP Secret Manager Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the GCP Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the GCP Secret Manager Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteGcpSecretManagerSecretSync tags: - Secret Syncs description: Delete the specified GCP Secret Manager Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager/sync-name/{syncName}: get: operationId: getGcpSecretManagerSecretSyncByName tags: - Secret Syncs description: Get the specified GCP Secret Manager Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the GCP Secret Manager Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the GCP Secret Manager Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager/{syncId}/sync-secrets: post: operationId: syncGcpSecretManagerSecretSync tags: - Secret Syncs description: Trigger a sync for the specified GCP Secret Manager Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager/{syncId}/import-secrets: post: operationId: importGcpSecretManagerSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified GCP Secret Manager Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or GCP Secret Manager. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gcp-secret-manager/{syncId}/remove-secrets: post: operationId: removeGcpSecretManagerSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified GCP Secret Manager Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GCP Secret Manager Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the GCP Secret Manager destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GCP Secret Manager destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GCP Secret Manager destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gcp name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gcp-secret-manager destinationConfig: anyOf: - type: object properties: scope: type: string enum: - global description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. required: - scope - projectId additionalProperties: false title: Global - type: object properties: scope: type: string enum: - region description: The Google project scope that secrets should be synced to. projectId: type: string minLength: 1 description: The ID of the Google project secrets should be synced to. locationId: type: string enum: - asia-southeast3 - asia-south2 - asia-east2 - asia-southeast2 - australia-southeast2 - asia-south1 - asia-northeast2 - asia-northeast3 - asia-southeast1 - australia-southeast1 - asia-east1 - asia-northeast1 - europe-west1 - europe-west10 - europe-north1 - europe-north2 - europe-west3 - europe-west2 - europe-southwest1 - europe-west8 - europe-west4 - europe-west12 - europe-west9 - europe-central2 - europe-west6 - us-central1 - us-west4 - us-west2 - northamerica-south1 - northamerica-northeast1 - us-east4 - us-central2 - us-west1 - us-west3 - us-east1 - northamerica-northeast2 - us-east5 - us-south1 - us-west8 - southamerica-east1 - southamerica-west1 - me-central2 - me-central1 - me-west1 - africa-south1 description: The ID of the Google project location secrets should be synced to (ie "us-west4"). required: - scope - projectId - locationId additionalProperties: false title: Region required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GCP Secret Manager required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault: get: operationId: listAzureKeyVaultSecretSyncs tags: - Secret Syncs description: List the Azure Key Vault Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Azure Key Vault Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAzureKeyVaultSecretSync tags: - Secret Syncs description: Create an Azure Key Vault Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Azure Key Vault Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure Key Vault Sync. connectionId: type: string format: uuid description: The ID of the Azure Key Vault Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault/{syncId}: get: operationId: getAzureKeyVaultSecretSync tags: - Secret Syncs description: Get the specified Azure Key Vault Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAzureKeyVaultSecretSync tags: - Secret Syncs description: Update the specified Azure Key Vault Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Azure Key Vault Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Azure Key Vault Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure Key Vault Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAzureKeyVaultSecretSync tags: - Secret Syncs description: Delete the specified Azure Key Vault Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault/sync-name/{syncName}: get: operationId: getAzureKeyVaultSecretSyncByName tags: - Secret Syncs description: Get the specified Azure Key Vault Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Azure Key Vault Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Azure Key Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault/{syncId}/sync-secrets: post: operationId: syncAzureKeyVaultSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Azure Key Vault Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault/{syncId}/import-secrets: post: operationId: importAzureKeyVaultSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Azure Key Vault Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Azure Key Vault. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-key-vault/{syncId}/remove-secrets: post: operationId: removeAzureKeyVaultSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Azure Key Vault Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Key Vault Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure Key Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure Key Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure Key Vault destination when syncing. disableCertificateImport: type: boolean description: Whether Infisical should skip importing certificate objects from Azure Key Vault when syncing secrets. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-key-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-key-vault destinationConfig: type: object properties: vaultBaseUrl: type: string format: uri minLength: 1 description: 'The base URL of the Azure Key Vault to sync secrets to. Example: https://example.vault.azure.net/' required: - vaultBaseUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Key Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration: get: operationId: listAzureAppConfigurationSecretSyncs tags: - Secret Syncs description: List the Azure App Configuration Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Azure App Configuration Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAzureAppConfigurationSecretSync tags: - Secret Syncs description: Create an Azure App Configuration Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Azure App Configuration Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure App Configuration Sync. connectionId: type: string format: uuid description: The ID of the Azure App Configuration Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration/{syncId}: get: operationId: getAzureAppConfigurationSecretSync tags: - Secret Syncs description: Get the specified Azure App Configuration Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAzureAppConfigurationSecretSync tags: - Secret Syncs description: Update the specified Azure App Configuration Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Azure App Configuration Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Azure App Configuration Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure App Configuration Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAzureAppConfigurationSecretSync tags: - Secret Syncs description: Delete the specified Azure App Configuration Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration/sync-name/{syncName}: get: operationId: getAzureAppConfigurationSecretSyncByName tags: - Secret Syncs description: Get the specified Azure App Configuration Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Azure App Configuration Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Azure App Configuration Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration/{syncId}/sync-secrets: post: operationId: syncAzureAppConfigurationSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Azure App Configuration Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration/{syncId}/import-secrets: post: operationId: importAzureAppConfigurationSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Azure App Configuration Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Azure App Configuration. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-app-configuration/{syncId}/remove-secrets: post: operationId: removeAzureAppConfigurationSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Azure App Configuration Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure App Configuration Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Azure App Configuration destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure App Configuration destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure App Configuration destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-app-configuration name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-app-configuration destinationConfig: type: object properties: configurationUrl: type: string minLength: 1 description: 'The URL of the Azure App Configuration to sync secrets to. Example: https://example.azconfig.io/' label: type: string description: An optional label to assign to secrets created in Azure App Configuration. required: - configurationUrl additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure App Configuration required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops: get: operationId: listAzureDevopsSecretSyncs tags: - Secret Syncs description: List the Azure DevOps Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Azure DevOps Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAzureDevopsSecretSync tags: - Secret Syncs description: Create an Azure DevOps Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Azure DevOps Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure DevOps Sync. connectionId: type: string format: uuid description: The ID of the Azure DevOps Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops/{syncId}: get: operationId: getAzureDevopsSecretSync tags: - Secret Syncs description: Get the specified Azure DevOps Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAzureDevopsSecretSync tags: - Secret Syncs description: Update the specified Azure DevOps Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Azure DevOps Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Azure DevOps Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure DevOps Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAzureDevopsSecretSync tags: - Secret Syncs description: Delete the specified Azure DevOps Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops/sync-name/{syncName}: get: operationId: getAzureDevopsSecretSyncByName tags: - Secret Syncs description: Get the specified Azure DevOps Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Azure DevOps Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Azure DevOps Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops/{syncId}/sync-secrets: post: operationId: syncAzureDevopsSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Azure DevOps Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops/{syncId}/import-secrets: post: operationId: importAzureDevopsSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Azure DevOps Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Azure DevOps. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-devops/{syncId}/remove-secrets: post: operationId: removeAzureDevopsSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Azure DevOps Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure DevOps Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure DevOps destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Azure DevOps destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Azure DevOps destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-devops name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-devops destinationConfig: type: object properties: devopsProjectId: type: string minLength: 1 description: The ID of the Azure DevOps project to sync secrets to. devopsProjectName: type: string description: The name of the Azure DevOps project to sync secrets to. required: - devopsProjectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure DevOps required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks: get: operationId: listDatabricksSecretSyncs tags: - Secret Syncs description: List the Databricks Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Databricks Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createDatabricksSecretSync tags: - Secret Syncs description: Create a Databricks Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Databricks Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Databricks Sync. connectionId: type: string format: uuid description: The ID of the Databricks Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks/{syncId}: get: operationId: getDatabricksSecretSync tags: - Secret Syncs description: Get the specified Databricks Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateDatabricksSecretSync tags: - Secret Syncs description: Update the specified Databricks Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Databricks Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Databricks Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Databricks Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteDatabricksSecretSync tags: - Secret Syncs description: Delete the specified Databricks Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks/sync-name/{syncName}: get: operationId: getDatabricksSecretSyncByName tags: - Secret Syncs description: Get the specified Databricks Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Databricks Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Databricks Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks/{syncId}/sync-secrets: post: operationId: syncDatabricksSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Databricks Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks/{syncId}/import-secrets: post: operationId: importDatabricksSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Databricks Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Databricks. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/databricks/{syncId}/remove-secrets: post: operationId: removeDatabricksSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Databricks Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Databricks Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Databricks destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Databricks destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Databricks destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - databricks name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - databricks destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Databricks secret scope that secrets should be synced to. required: - scope additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Databricks required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec: get: operationId: listHumanitecSecretSyncs tags: - Secret Syncs description: List the Humanitec Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Humanitec Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createHumanitecSecretSync tags: - Secret Syncs description: Create a Humanitec Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Humanitec Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Humanitec Sync. connectionId: type: string format: uuid description: The ID of the Humanitec Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec/{syncId}: get: operationId: getHumanitecSecretSync tags: - Secret Syncs description: Get the specified Humanitec Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateHumanitecSecretSync tags: - Secret Syncs description: Update the specified Humanitec Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Humanitec Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Humanitec Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Humanitec Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteHumanitecSecretSync tags: - Secret Syncs description: Delete the specified Humanitec Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec/sync-name/{syncName}: get: operationId: getHumanitecSecretSyncByName tags: - Secret Syncs description: Get the specified Humanitec Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Humanitec Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Humanitec Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec/{syncId}/sync-secrets: post: operationId: syncHumanitecSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Humanitec Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec/{syncId}/import-secrets: post: operationId: importHumanitecSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Humanitec Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Humanitec. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/humanitec/{syncId}/remove-secrets: post: operationId: removeHumanitecSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Humanitec Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Humanitec Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Humanitec destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Humanitec destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Humanitec destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - humanitec name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - humanitec destinationConfig: anyOf: - type: object properties: scope: type: string enum: - application description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. required: - scope - org - app additionalProperties: false - type: object properties: scope: type: string enum: - environment description: The Humanitec scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Humanitec org to sync secrets to. app: type: string minLength: 1 description: The ID of the Humanitec app to sync secrets to. env: type: string minLength: 1 description: The ID of the Humanitec environment to sync secrets to. required: - scope - org - app - env additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Humanitec required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud: get: operationId: listTerraformCloudSecretSyncs tags: - Secret Syncs description: List the Terraform Cloud Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Terraform Cloud Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createTerraformCloudSecretSync tags: - Secret Syncs description: Create a Terraform Cloud Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Terraform Cloud Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Terraform Cloud Sync. connectionId: type: string format: uuid description: The ID of the Terraform Cloud Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud/{syncId}: get: operationId: getTerraformCloudSecretSync tags: - Secret Syncs description: Get the specified Terraform Cloud Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateTerraformCloudSecretSync tags: - Secret Syncs description: Update the specified Terraform Cloud Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Terraform Cloud Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Terraform Cloud Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Terraform Cloud Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteTerraformCloudSecretSync tags: - Secret Syncs description: Delete the specified Terraform Cloud Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud/sync-name/{syncName}: get: operationId: getTerraformCloudSecretSyncByName tags: - Secret Syncs description: Get the specified Terraform Cloud Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Terraform Cloud Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Terraform Cloud Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud/{syncId}/sync-secrets: post: operationId: syncTerraformCloudSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Terraform Cloud Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud/{syncId}/import-secrets: post: operationId: importTerraformCloudSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Terraform Cloud Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Terraform Cloud. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/terraform-cloud/{syncId}/remove-secrets: post: operationId: removeTerraformCloudSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Terraform Cloud Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Terraform Cloud Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Terraform Cloud destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Terraform Cloud destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Terraform Cloud destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - terraform-cloud name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - terraform-cloud destinationConfig: anyOf: - type: object properties: scope: type: string enum: - variable-set description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. variableSetName: type: string minLength: 1 description: The name of the Terraform Cloud Variable Set to sync secrets to. variableSetId: type: string minLength: 1 description: The ID of the Terraform Cloud Variable Set to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - variableSetName - variableSetId - category additionalProperties: false - type: object properties: scope: type: string enum: - workspace description: The Terraform Cloud scope that secrets should be synced to. org: type: string minLength: 1 description: The ID of the Terraform Cloud org to sync secrets to. workspaceName: type: string minLength: 1 description: The name of the Terraform Cloud workspace to sync secrets to. workspaceId: type: string minLength: 1 description: The ID of the Terraform Cloud workspace to sync secrets to. category: type: string enum: - env - terraform description: The Terraform Cloud category that secrets should be synced to. required: - scope - org - workspaceName - workspaceId - category additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Terraform Cloud required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda: get: operationId: listCamundaSecretSyncs tags: - Secret Syncs description: List the Camunda Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Camunda Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createCamundaSecretSync tags: - Secret Syncs description: Create a Camunda Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Camunda Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Camunda Sync. connectionId: type: string format: uuid description: The ID of the Camunda Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda/{syncId}: get: operationId: getCamundaSecretSync tags: - Secret Syncs description: Get the specified Camunda Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCamundaSecretSync tags: - Secret Syncs description: Update the specified Camunda Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Camunda Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Camunda Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Camunda Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteCamundaSecretSync tags: - Secret Syncs description: Delete the specified Camunda Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda/sync-name/{syncName}: get: operationId: getCamundaSecretSyncByName tags: - Secret Syncs description: Get the specified Camunda Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Camunda Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Camunda Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda/{syncId}/sync-secrets: post: operationId: syncCamundaSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Camunda Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda/{syncId}/import-secrets: post: operationId: importCamundaSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Camunda Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Camunda. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/camunda/{syncId}/remove-secrets: post: operationId: removeCamundaSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Camunda Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Camunda Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Camunda destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Camunda destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Camunda destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - camunda name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - camunda destinationConfig: type: object properties: scope: type: string minLength: 1 description: The Camunda scope that secrets should be synced to. clusterUUID: type: string minLength: 1 description: The UUID of the Camunda cluster that secrets should be synced to. required: - scope - clusterUUID additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Camunda required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel: get: operationId: listVercelSecretSyncs tags: - Secret Syncs description: List the Vercel Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Vercel Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createVercelSecretSync tags: - Secret Syncs description: Create a Vercel Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Vercel Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Vercel Sync. connectionId: type: string format: uuid description: The ID of the Vercel Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel/{syncId}: get: operationId: getVercelSecretSync tags: - Secret Syncs description: Get the specified Vercel Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateVercelSecretSync tags: - Secret Syncs description: Update the specified Vercel Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Vercel Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Vercel Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Vercel Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteVercelSecretSync tags: - Secret Syncs description: Delete the specified Vercel Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel/sync-name/{syncName}: get: operationId: getVercelSecretSyncByName tags: - Secret Syncs description: Get the specified Vercel Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Vercel Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Vercel Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel/{syncId}/sync-secrets: post: operationId: syncVercelSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Vercel Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel/{syncId}/import-secrets: post: operationId: importVercelSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Vercel Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Vercel. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/vercel/{syncId}/remove-secrets: post: operationId: removeVercelSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Vercel Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Vercel Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Vercel destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Vercel destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Vercel destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - vercel name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - vercel destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project app: type: string minLength: 1 description: The ID of the Vercel app to sync secrets to. appName: type: string minLength: 1 description: The name of the Vercel app to sync secrets to. env: anyOf: - type: string enum: - development - preview - production - type: string description: The ID of the Vercel environment to sync secrets to. branch: type: string description: The branch to sync preview secrets to. teamId: type: string description: The ID of the Vercel team to sync secrets to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - app - appName - env - teamId additionalProperties: false - type: object properties: scope: type: string enum: - team teamId: type: string minLength: 1 description: The ID of the Vercel team to sync secrets to. teamName: type: string description: The name of the team to sync the secrets to. This is an optional field only intended for display purposes. targetEnvironments: type: array items: type: string enum: - development - preview - production default: [] description: An optional array of Vercel default environments (development, preview, production) to add shared environment variables to. applyToAllCustomEnvironments: type: boolean default: false description: Whether to apply shared environment variables to all custom environments in the team. targetProjects: type: array items: type: string description: An optional array of Vercel projects to add shared environment variables to. sensitive: type: boolean default: false description: Whether to create Vercel environment variables as Sensitive (cannot be read back). Not allowed when targeting the Development environment. required: - scope - teamId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Vercel required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill: get: operationId: listWindmillSecretSyncs tags: - Secret Syncs description: List the Windmill Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Windmill Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createWindmillSecretSync tags: - Secret Syncs description: Create a Windmill Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Windmill Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Windmill Sync. connectionId: type: string format: uuid description: The ID of the Windmill Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill/{syncId}: get: operationId: getWindmillSecretSync tags: - Secret Syncs description: Get the specified Windmill Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateWindmillSecretSync tags: - Secret Syncs description: Update the specified Windmill Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Windmill Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Windmill Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Windmill Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteWindmillSecretSync tags: - Secret Syncs description: Delete the specified Windmill Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill/sync-name/{syncName}: get: operationId: getWindmillSecretSyncByName tags: - Secret Syncs description: Get the specified Windmill Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Windmill Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Windmill Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill/{syncId}/sync-secrets: post: operationId: syncWindmillSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Windmill Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill/{syncId}/import-secrets: post: operationId: importWindmillSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Windmill Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Windmill. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/windmill/{syncId}/remove-secrets: post: operationId: removeWindmillSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Windmill Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Windmill Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Windmill destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Windmill destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Windmill destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - windmill name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - windmill destinationConfig: type: object properties: workspace: type: string minLength: 1 description: The Windmill workspace to sync secrets to. path: type: string minLength: 1 description: The Windmill workspace path to sync secrets to. required: - workspace - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Windmill required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault: get: operationId: listHashicorpVaultSecretSyncs tags: - Secret Syncs description: List the Hashicorp Vault Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Hashicorp Vault Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createHashicorpVaultSecretSync tags: - Secret Syncs description: Create a Hashicorp Vault Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Hashicorp Vault Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Hashicorp Vault Sync. connectionId: type: string format: uuid description: The ID of the Hashicorp Vault Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault/{syncId}: get: operationId: getHashicorpVaultSecretSync tags: - Secret Syncs description: Get the specified Hashicorp Vault Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateHashicorpVaultSecretSync tags: - Secret Syncs description: Update the specified Hashicorp Vault Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Hashicorp Vault Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Hashicorp Vault Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Hashicorp Vault Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteHashicorpVaultSecretSync tags: - Secret Syncs description: Delete the specified Hashicorp Vault Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault/sync-name/{syncName}: get: operationId: getHashicorpVaultSecretSyncByName tags: - Secret Syncs description: Get the specified Hashicorp Vault Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Hashicorp Vault Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Hashicorp Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault/{syncId}/sync-secrets: post: operationId: syncHashicorpVaultSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Hashicorp Vault Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault/{syncId}/import-secrets: post: operationId: importHashicorpVaultSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Hashicorp Vault Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Hashicorp Vault. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/hashicorp-vault/{syncId}/remove-secrets: post: operationId: removeHashicorpVaultSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Hashicorp Vault Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Hashicorp Vault Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Hashicorp Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Hashicorp Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Hashicorp Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - hashicorp-vault name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - hashicorp-vault destinationConfig: type: object properties: mount: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault Secrets Engine Mount to sync secrets to. path: type: string minLength: 1 maxLength: 128 description: The Hashicorp Vault path to sync secrets to. required: - mount - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Hashicorp Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity: get: operationId: listTeamcitySecretSyncs tags: - Secret Syncs description: List the TeamCity Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list TeamCity Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createTeamcitySecretSync tags: - Secret Syncs description: Create a TeamCity Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the TeamCity Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the TeamCity Sync. connectionId: type: string format: uuid description: The ID of the TeamCity Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity/{syncId}: get: operationId: getTeamcitySecretSync tags: - Secret Syncs description: Get the specified TeamCity Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateTeamcitySecretSync tags: - Secret Syncs description: Update the specified TeamCity Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the TeamCity Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the TeamCity Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the TeamCity Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteTeamcitySecretSync tags: - Secret Syncs description: Delete the specified TeamCity Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity/sync-name/{syncName}: get: operationId: getTeamcitySecretSyncByName tags: - Secret Syncs description: Get the specified TeamCity Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the TeamCity Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the TeamCity Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity/{syncId}/sync-secrets: post: operationId: syncTeamcitySecretSync tags: - Secret Syncs description: Trigger a sync for the specified TeamCity Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity/{syncId}/import-secrets: post: operationId: importTeamcitySecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified TeamCity Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or TeamCity. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/teamcity/{syncId}/remove-secrets: post: operationId: removeTeamcitySecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified TeamCity Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the TeamCity Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the TeamCity destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the TeamCity destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the TeamCity destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - teamcity name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - teamcity destinationConfig: type: object properties: project: type: string minLength: 1 description: The TeamCity project to sync secrets to. buildConfig: type: string description: The TeamCity build configuration to sync secrets to. required: - project additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: TeamCity required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault: get: operationId: listOciVaultSecretSyncs tags: - Secret Syncs description: List the OCI Vault Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list OCI Vault Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createOciVaultSecretSync tags: - Secret Syncs description: Create an OCI Vault Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the OCI Vault Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the OCI Vault Sync. connectionId: type: string format: uuid description: The ID of the OCI Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault/{syncId}: get: operationId: getOciVaultSecretSync tags: - Secret Syncs description: Get the specified OCI Vault Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateOciVaultSecretSync tags: - Secret Syncs description: Update the specified OCI Vault Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the OCI Vault Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the OCI Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the OCI Vault Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteOciVaultSecretSync tags: - Secret Syncs description: Delete the specified OCI Vault Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault/sync-name/{syncName}: get: operationId: getOciVaultSecretSyncByName tags: - Secret Syncs description: Get the specified OCI Vault Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the OCI Vault Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the OCI Vault Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault/{syncId}/sync-secrets: post: operationId: syncOciVaultSecretSync tags: - Secret Syncs description: Trigger a sync for the specified OCI Vault Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault/{syncId}/import-secrets: post: operationId: importOciVaultSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified OCI Vault Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or OCI Vault. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/oci-vault/{syncId}/remove-secrets: post: operationId: removeOciVaultSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified OCI Vault Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OCI Vault Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OCI Vault destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OCI Vault destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OCI Vault destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - oci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - oci-vault destinationConfig: type: object properties: compartmentOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the compartment where the vault is located. vaultOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the vault to sync secrets to. keyOcid: type: string minLength: 1 description: The OCID (Oracle Cloud Identifier) of the encryption key to use when creating secrets in the vault. required: - compartmentOcid - vaultOcid - keyOcid additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OCI Vault required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password: get: operationId: listOnePasswordSecretSyncs tags: - Secret Syncs description: List the 1Password Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list 1Password Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createOnePasswordSecretSync tags: - Secret Syncs description: Create a 1Password Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the 1Password Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the 1Password Sync. connectionId: type: string format: uuid description: The ID of the 1Password Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password/{syncId}: get: operationId: getOnePasswordSecretSync tags: - Secret Syncs description: Get the specified 1Password Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateOnePasswordSecretSync tags: - Secret Syncs description: Update the specified 1Password Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the 1Password Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the 1Password Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the 1Password Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteOnePasswordSecretSync tags: - Secret Syncs description: Delete the specified 1Password Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password/sync-name/{syncName}: get: operationId: getOnePasswordSecretSyncByName tags: - Secret Syncs description: Get the specified 1Password Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the 1Password Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the 1Password Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password/{syncId}/sync-secrets: post: operationId: syncOnePasswordSecretSync tags: - Secret Syncs description: Trigger a sync for the specified 1Password Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password/{syncId}/import-secrets: post: operationId: importOnePasswordSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified 1Password Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or 1Password. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/1password/{syncId}/remove-secrets: post: operationId: removeOnePasswordSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified 1Password Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the 1Password Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the 1Password destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the 1Password destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the 1Password destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - 1password name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - 1password destinationConfig: type: object properties: vaultId: type: string minLength: 1 description: The ID of the 1Password vault to sync secrets to. valueLabel: type: string description: The label of the entry that holds the secret value. required: - vaultId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: 1Password required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku: get: operationId: listHerokuSecretSyncs tags: - Secret Syncs description: List the Heroku Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Heroku Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createHerokuSecretSync tags: - Secret Syncs description: Create a Heroku Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Heroku Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Heroku Sync. connectionId: type: string format: uuid description: The ID of the Heroku Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku/{syncId}: get: operationId: getHerokuSecretSync tags: - Secret Syncs description: Get the specified Heroku Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateHerokuSecretSync tags: - Secret Syncs description: Update the specified Heroku Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Heroku Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Heroku Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Heroku Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteHerokuSecretSync tags: - Secret Syncs description: Delete the specified Heroku Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku/sync-name/{syncName}: get: operationId: getHerokuSecretSyncByName tags: - Secret Syncs description: Get the specified Heroku Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Heroku Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Heroku Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku/{syncId}/sync-secrets: post: operationId: syncHerokuSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Heroku Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku/{syncId}/import-secrets: post: operationId: importHerokuSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Heroku Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Heroku. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/heroku/{syncId}/remove-secrets: post: operationId: removeHerokuSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Heroku Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Heroku Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Heroku destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Heroku destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Heroku destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - heroku name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - heroku destinationConfig: type: object properties: app: type: string minLength: 1 description: The ID of the Heroku app to sync secrets to. appName: type: string minLength: 1 description: The name of the Heroku app to sync secrets to. required: - app - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Heroku required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render: get: operationId: listRenderSecretSyncs tags: - Secret Syncs description: List the Render Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Render Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createRenderSecretSync tags: - Secret Syncs description: Create a Render Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Render Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Render Sync. connectionId: type: string format: uuid description: The ID of the Render Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render/{syncId}: get: operationId: getRenderSecretSync tags: - Secret Syncs description: Get the specified Render Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateRenderSecretSync tags: - Secret Syncs description: Update the specified Render Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Render Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Render Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Render Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteRenderSecretSync tags: - Secret Syncs description: Delete the specified Render Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render/sync-name/{syncName}: get: operationId: getRenderSecretSyncByName tags: - Secret Syncs description: Get the specified Render Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Render Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Render Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render/{syncId}/sync-secrets: post: operationId: syncRenderSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Render Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render/{syncId}/import-secrets: post: operationId: importRenderSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Render Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Render. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/render/{syncId}/remove-secrets: post: operationId: removeRenderSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Render Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Render Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Render destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Render destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Render destination when syncing. autoRedeployServices: type: boolean description: Whether Infisical should automatically redeploy the configured Render service upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - render name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - render destinationConfig: anyOf: - type: object properties: scope: type: string enum: - service description: The Render scope that secrets should be synced to. serviceId: type: string minLength: 1 description: The ID of the Render service to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - serviceId - type additionalProperties: false - type: object properties: scope: type: string enum: - environment-group description: The Render scope that secrets should be synced to. environmentGroupId: type: string minLength: 1 description: The ID of the Render environment group to sync secrets to. type: type: string enum: - env - file description: The Render resource type to sync secrets to. required: - scope - environmentGroupId - type additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Render required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio: get: operationId: listFlyioSecretSyncs tags: - Secret Syncs description: List the Fly.io Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Fly.io Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createFlyioSecretSync tags: - Secret Syncs description: Create a Fly.io Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Fly.io Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Fly.io Sync. connectionId: type: string format: uuid description: The ID of the Fly.io Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio/{syncId}: get: operationId: getFlyioSecretSync tags: - Secret Syncs description: Get the specified Fly.io Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateFlyioSecretSync tags: - Secret Syncs description: Update the specified Fly.io Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Fly.io Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Fly.io Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Fly.io Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteFlyioSecretSync tags: - Secret Syncs description: Delete the specified Fly.io Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio/sync-name/{syncName}: get: operationId: getFlyioSecretSyncByName tags: - Secret Syncs description: Get the specified Fly.io Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Fly.io Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Fly.io Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio/{syncId}/sync-secrets: post: operationId: syncFlyioSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Fly.io Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio/{syncId}/import-secrets: post: operationId: importFlyioSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Fly.io Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Fly.io. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/flyio/{syncId}/remove-secrets: post: operationId: removeFlyioSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Fly.io Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Fly.io Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Fly.io destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Fly.io destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Fly.io destination when syncing. autoRedeploy: type: boolean description: Whether Infisical should automatically redeploy the configured Fly.io app upon secret changes. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - flyio name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - flyio destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 description: The ID of the Fly.io app to sync secrets to. required: - appId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Fly.io required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab: get: operationId: listGitLabSecretSyncs tags: - Secret Syncs description: List the GitLab Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list GitLab Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createGitLabSecretSync tags: - Secret Syncs description: Create a GitLab Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the GitLab Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the GitLab Sync. connectionId: type: string format: uuid description: The ID of the GitLab Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab/{syncId}: get: operationId: getGitLabSecretSync tags: - Secret Syncs description: Get the specified GitLab Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateGitLabSecretSync tags: - Secret Syncs description: Update the specified GitLab Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the GitLab Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the GitLab Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the GitLab Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteGitLabSecretSync tags: - Secret Syncs description: Delete the specified GitLab Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab/sync-name/{syncName}: get: operationId: getGitLabSecretSyncByName tags: - Secret Syncs description: Get the specified GitLab Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the GitLab Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the GitLab Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab/{syncId}/sync-secrets: post: operationId: syncGitLabSecretSync tags: - Secret Syncs description: Trigger a sync for the specified GitLab Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab/{syncId}/import-secrets: post: operationId: importGitLabSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified GitLab Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or GitLab. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/gitlab/{syncId}/remove-secrets: post: operationId: removeGitLabSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified GitLab Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the GitLab Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the GitLab destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the GitLab destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the GitLab destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - gitlab name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - gitlab destinationConfig: anyOf: - type: object properties: scope: type: string enum: - project description: 'The GitLab scope that secrets should be synced to. (default: project)' projectId: type: string minLength: 1 description: The GitLab Project ID to sync secrets to. projectName: type: string minLength: 1 description: The GitLab Project Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - projectId - projectName additionalProperties: false - type: object properties: scope: type: string enum: - group description: 'The GitLab scope that secrets should be synced to. (default: project)' groupId: type: string minLength: 1 description: The GitLab Group ID to sync secrets to. groupName: type: string minLength: 1 description: The GitLab Group Name to sync secrets to. targetEnvironment: type: string default: '*' description: 'The GitLab environment scope that secrets should be synced to. (default: *)' shouldProtectSecrets: type: boolean default: false description: Whether variables should be protected shouldMaskSecrets: type: boolean default: false description: Whether variables should be masked in logs shouldHideSecrets: type: boolean default: false description: Whether variables should be hidden required: - scope - groupId - groupName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: GitLab required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages: get: operationId: listCloudflarePagesSecretSyncs tags: - Secret Syncs description: List the Cloudflare Pages Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Cloudflare Pages Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createCloudflarePagesSecretSync tags: - Secret Syncs description: Create a Cloudflare Pages Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Cloudflare Pages Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Cloudflare Pages Sync. connectionId: type: string format: uuid description: The ID of the Cloudflare Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages/{syncId}: get: operationId: getCloudflarePagesSecretSync tags: - Secret Syncs description: Get the specified Cloudflare Pages Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCloudflarePagesSecretSync tags: - Secret Syncs description: Update the specified Cloudflare Pages Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Cloudflare Pages Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Cloudflare Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Cloudflare Pages Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteCloudflarePagesSecretSync tags: - Secret Syncs description: Delete the specified Cloudflare Pages Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages/sync-name/{syncName}: get: operationId: getCloudflarePagesSecretSyncByName tags: - Secret Syncs description: Get the specified Cloudflare Pages Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Cloudflare Pages Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Cloudflare Pages Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages/{syncId}/sync-secrets: post: operationId: syncCloudflarePagesSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Cloudflare Pages Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages/{syncId}/import-secrets: post: operationId: importCloudflarePagesSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Cloudflare Pages Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Cloudflare Pages. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-pages/{syncId}/remove-secrets: post: operationId: removeCloudflarePagesSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Cloudflare Pages Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Pages Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Pages destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Pages destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Pages destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-pages destinationConfig: type: object properties: projectName: type: string minLength: 1 description: The name of the Cloudflare Pages project to sync secrets to. environment: type: string minLength: 1 description: The environment of the Cloudflare Pages project to sync secrets to. required: - projectName - environment additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Pages required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers: get: operationId: listCloudflareWorkersSecretSyncs tags: - Secret Syncs description: List the Cloudflare Workers Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Cloudflare Workers Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createCloudflareWorkersSecretSync tags: - Secret Syncs description: Create a Cloudflare Workers Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Cloudflare Workers Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Cloudflare Workers Sync. connectionId: type: string format: uuid description: The ID of the Cloudflare Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers/{syncId}: get: operationId: getCloudflareWorkersSecretSync tags: - Secret Syncs description: Get the specified Cloudflare Workers Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCloudflareWorkersSecretSync tags: - Secret Syncs description: Update the specified Cloudflare Workers Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Cloudflare Workers Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Cloudflare Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Cloudflare Workers Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteCloudflareWorkersSecretSync tags: - Secret Syncs description: Delete the specified Cloudflare Workers Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers/sync-name/{syncName}: get: operationId: getCloudflareWorkersSecretSyncByName tags: - Secret Syncs description: Get the specified Cloudflare Workers Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Cloudflare Workers Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Cloudflare Workers Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers/{syncId}/sync-secrets: post: operationId: syncCloudflareWorkersSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Cloudflare Workers Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers/{syncId}/import-secrets: post: operationId: importCloudflareWorkersSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Cloudflare Workers Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Cloudflare Workers. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/cloudflare-workers/{syncId}/remove-secrets: post: operationId: removeCloudflareWorkersSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Cloudflare Workers Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Cloudflare Workers Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Cloudflare Workers destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Cloudflare Workers destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Cloudflare Workers destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - cloudflare name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - cloudflare-workers destinationConfig: type: object properties: scriptId: type: string minLength: 1 maxLength: 64 description: The ID of the Cloudflare Workers script to sync secrets to. required: - scriptId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Cloudflare Workers required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase: get: operationId: listSupabaseSecretSyncs tags: - Secret Syncs description: List the Supabase Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Supabase Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createSupabaseSecretSync tags: - Secret Syncs description: Create a Supabase Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Supabase Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Supabase Sync. connectionId: type: string format: uuid description: The ID of the Supabase Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase/{syncId}: get: operationId: getSupabaseSecretSync tags: - Secret Syncs description: Get the specified Supabase Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateSupabaseSecretSync tags: - Secret Syncs description: Update the specified Supabase Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Supabase Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Supabase Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Supabase Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteSupabaseSecretSync tags: - Secret Syncs description: Delete the specified Supabase Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase/sync-name/{syncName}: get: operationId: getSupabaseSecretSyncByName tags: - Secret Syncs description: Get the specified Supabase Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Supabase Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Supabase Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase/{syncId}/sync-secrets: post: operationId: syncSupabaseSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Supabase Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase/{syncId}/import-secrets: post: operationId: importSupabaseSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Supabase Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Supabase. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/supabase/{syncId}/remove-secrets: post: operationId: removeSupabaseSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Supabase Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Supabase Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Supabase destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Supabase destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Supabase destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - supabase name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - supabase destinationConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 projectName: type: string maxLength: 255 minLength: 1 required: - projectId - projectName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Supabase required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix: get: operationId: listZabbixSecretSyncs tags: - Secret Syncs description: List the Zabbix Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Zabbix Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createZabbixSecretSync tags: - Secret Syncs description: Create a Zabbix Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Zabbix Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Zabbix Sync. connectionId: type: string format: uuid description: The ID of the Zabbix Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix/{syncId}: get: operationId: getZabbixSecretSync tags: - Secret Syncs description: Get the specified Zabbix Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateZabbixSecretSync tags: - Secret Syncs description: Update the specified Zabbix Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Zabbix Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Zabbix Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Zabbix Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteZabbixSecretSync tags: - Secret Syncs description: Delete the specified Zabbix Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix/sync-name/{syncName}: get: operationId: getZabbixSecretSyncByName tags: - Secret Syncs description: Get the specified Zabbix Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Zabbix Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Zabbix Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix/{syncId}/sync-secrets: post: operationId: syncZabbixSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Zabbix Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix/{syncId}/import-secrets: post: operationId: importZabbixSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Zabbix Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Zabbix. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/zabbix/{syncId}/remove-secrets: post: operationId: removeZabbixSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Zabbix Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Zabbix Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Zabbix destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Zabbix destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Zabbix destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - zabbix name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - zabbix destinationConfig: anyOf: - type: object properties: scope: type: string enum: - host description: The Zabbix scope that secrets should be synced to. hostId: type: string minLength: 1 maxLength: 255 description: The ID of the Zabbix host to sync secrets to. hostName: type: string minLength: 1 maxLength: 255 description: The name of the Zabbix host to sync secrets to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - hostId - hostName - macroType additionalProperties: false - type: object properties: scope: type: string enum: - global description: The Zabbix scope that secrets should be synced to. macroType: type: number minimum: 0 maximum: 1 description: 'The type of macro to sync secrets to. (0: Text, 1: Secret)' required: - scope - macroType additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Zabbix required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway: get: operationId: listRailwaySecretSyncs tags: - Secret Syncs description: List the Railway Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Railway Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createRailwaySecretSync tags: - Secret Syncs description: Create a Railway Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Railway Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Railway Sync. connectionId: type: string format: uuid description: The ID of the Railway Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway/{syncId}: get: operationId: getRailwaySecretSync tags: - Secret Syncs description: Get the specified Railway Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateRailwaySecretSync tags: - Secret Syncs description: Update the specified Railway Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Railway Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Railway Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Railway Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteRailwaySecretSync tags: - Secret Syncs description: Delete the specified Railway Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway/sync-name/{syncName}: get: operationId: getRailwaySecretSyncByName tags: - Secret Syncs description: Get the specified Railway Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Railway Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Railway Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway/{syncId}/sync-secrets: post: operationId: syncRailwaySecretSync tags: - Secret Syncs description: Trigger a sync for the specified Railway Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway/{syncId}/import-secrets: post: operationId: importRailwaySecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Railway Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Railway. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/railway/{syncId}/remove-secrets: post: operationId: removeRailwaySecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Railway Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Railway Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Railway destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Railway destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Railway destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - railway name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - railway destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Railway project to sync secrets to. projectName: type: string description: The name of the Railway project to sync secrets to. environmentId: type: string minLength: 1 description: The Railway environment to sync secrets to. environmentName: type: string description: The Railway environment to sync secrets to. serviceId: type: string description: The Railway service that secrets should be synced to. serviceName: type: string description: The Railway service that secrets should be synced to. required: - projectId - projectName - environmentId - environmentName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Railway required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly: get: operationId: listChecklySecretSyncs tags: - Secret Syncs description: List the Checkly Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Checkly Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createChecklySecretSync tags: - Secret Syncs description: Create a Checkly Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Checkly Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Checkly Sync. connectionId: type: string format: uuid description: The ID of the Checkly Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly/{syncId}: get: operationId: getChecklySecretSync tags: - Secret Syncs description: Get the specified Checkly Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateChecklySecretSync tags: - Secret Syncs description: Update the specified Checkly Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Checkly Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Checkly Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Checkly Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteChecklySecretSync tags: - Secret Syncs description: Delete the specified Checkly Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly/sync-name/{syncName}: get: operationId: getChecklySecretSyncByName tags: - Secret Syncs description: Get the specified Checkly Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Checkly Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Checkly Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly/{syncId}/sync-secrets: post: operationId: syncChecklySecretSync tags: - Secret Syncs description: Trigger a sync for the specified Checkly Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly/{syncId}/import-secrets: post: operationId: importChecklySecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Checkly Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Checkly. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/checkly/{syncId}/remove-secrets: post: operationId: removeChecklySecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Checkly Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Checkly Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Checkly destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Checkly destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Checkly destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - checkly name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - checkly destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 accountName: type: string minLength: 1 maxLength: 255 groupId: type: string minLength: 1 maxLength: 255 groupName: type: string minLength: 1 maxLength: 255 required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Checkly required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform: get: operationId: listDigitalOceanAppPlatformSecretSyncs tags: - Secret Syncs description: List the Digital Ocean App Platform Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Digital Ocean App Platform Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createDigitalOceanAppPlatformSecretSync tags: - Secret Syncs description: Create a Digital Ocean App Platform Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Digital Ocean App Platform Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Digital Ocean App Platform Sync. connectionId: type: string format: uuid description: The ID of the DigitalOcean App Platform Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform/{syncId}: get: operationId: getDigitalOceanAppPlatformSecretSync tags: - Secret Syncs description: Get the specified Digital Ocean App Platform Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateDigitalOceanAppPlatformSecretSync tags: - Secret Syncs description: Update the specified Digital Ocean App Platform Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Digital Ocean App Platform Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the DigitalOcean App Platform Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Digital Ocean App Platform Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteDigitalOceanAppPlatformSecretSync tags: - Secret Syncs description: Delete the specified Digital Ocean App Platform Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform/sync-name/{syncName}: get: operationId: getDigitalOceanAppPlatformSecretSyncByName tags: - Secret Syncs description: Get the specified Digital Ocean App Platform Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Digital Ocean App Platform Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Digital Ocean App Platform Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform/{syncId}/sync-secrets: post: operationId: syncDigitalOceanAppPlatformSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Digital Ocean App Platform Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform/{syncId}/import-secrets: post: operationId: importDigitalOceanAppPlatformSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Digital Ocean App Platform Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Digital Ocean App Platform. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/digital-ocean-app-platform/{syncId}/remove-secrets: post: operationId: removeDigitalOceanAppPlatformSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Digital Ocean App Platform Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Digital Ocean App Platform Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Digital Ocean App Platform destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Digital Ocean App Platform destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Digital Ocean App Platform destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - digital-ocean name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - digital-ocean-app-platform destinationConfig: type: object properties: appId: type: string minLength: 1 maxLength: 255 appName: type: string minLength: 1 maxLength: 255 required: - appId - appName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Digital Ocean App Platform required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify: get: operationId: listNetlifySecretSyncs tags: - Secret Syncs description: List the Netlify Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Netlify Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createNetlifySecretSync tags: - Secret Syncs description: Create a Netlify Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Netlify Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Netlify Sync. connectionId: type: string format: uuid description: The ID of the Netlify Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify/{syncId}: get: operationId: getNetlifySecretSync tags: - Secret Syncs description: Get the specified Netlify Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateNetlifySecretSync tags: - Secret Syncs description: Update the specified Netlify Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Netlify Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Netlify Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Netlify Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteNetlifySecretSync tags: - Secret Syncs description: Delete the specified Netlify Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify/sync-name/{syncName}: get: operationId: getNetlifySecretSyncByName tags: - Secret Syncs description: Get the specified Netlify Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Netlify Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Netlify Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify/{syncId}/sync-secrets: post: operationId: syncNetlifySecretSync tags: - Secret Syncs description: Trigger a sync for the specified Netlify Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify/{syncId}/import-secrets: post: operationId: importNetlifySecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Netlify Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Netlify. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/netlify/{syncId}/remove-secrets: post: operationId: removeNetlifySecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Netlify Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Netlify Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Netlify destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Netlify destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Netlify destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - netlify name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - netlify destinationConfig: type: object properties: accountId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify account to sync secrets to. accountName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify account to sync secrets to. siteId: type: string minLength: 1 maxLength: 255 description: The ID of the Netlify site to sync secrets to. siteName: type: string minLength: 1 maxLength: 255 description: The name of the Netlify site to sync secrets to. context: type: string enum: - all - deploy-preview - production - branch-deploy - dev - branch description: The Netlify context to sync secrets to. required: - accountId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Netlify required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank: get: operationId: listNorthflankSecretSyncs tags: - Secret Syncs description: List the Northflank Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Northflank Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createNorthflankSecretSync tags: - Secret Syncs description: Create a Northflank Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Northflank Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Northflank Sync. connectionId: type: string format: uuid description: The ID of the Northflank Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank/{syncId}: get: operationId: getNorthflankSecretSync tags: - Secret Syncs description: Get the specified Northflank Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateNorthflankSecretSync tags: - Secret Syncs description: Update the specified Northflank Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Northflank Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Northflank Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Northflank Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteNorthflankSecretSync tags: - Secret Syncs description: Delete the specified Northflank Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank/sync-name/{syncName}: get: operationId: getNorthflankSecretSyncByName tags: - Secret Syncs description: Get the specified Northflank Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Northflank Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Northflank Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank/{syncId}/sync-secrets: post: operationId: syncNorthflankSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Northflank Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank/{syncId}/import-secrets: post: operationId: importNorthflankSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Northflank Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Northflank. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/northflank/{syncId}/remove-secrets: post: operationId: removeNorthflankSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Northflank Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Northflank Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Northflank destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Northflank destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Northflank destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - northflank name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - northflank destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the Northflank project to sync secrets to. projectName: type: string description: The name of the Northflank project to sync secrets to. secretGroupId: type: string minLength: 1 description: The ID of the Northflank secret group to sync secrets to. secretGroupName: type: string description: The name of the Northflank secret group to sync secrets to. required: - projectId - secretGroupId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Northflank required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket: get: operationId: listBitbucketSecretSyncs tags: - Secret Syncs description: List the Bitbucket Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Bitbucket Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createBitbucketSecretSync tags: - Secret Syncs description: Create a Bitbucket Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Bitbucket Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Bitbucket Sync. connectionId: type: string format: uuid description: The ID of the Bitbucket Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket/{syncId}: get: operationId: getBitbucketSecretSync tags: - Secret Syncs description: Get the specified Bitbucket Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateBitbucketSecretSync tags: - Secret Syncs description: Update the specified Bitbucket Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Bitbucket Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Bitbucket Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Bitbucket Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteBitbucketSecretSync tags: - Secret Syncs description: Delete the specified Bitbucket Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket/sync-name/{syncName}: get: operationId: getBitbucketSecretSyncByName tags: - Secret Syncs description: Get the specified Bitbucket Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Bitbucket Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Bitbucket Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket/{syncId}/sync-secrets: post: operationId: syncBitbucketSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Bitbucket Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket/{syncId}/import-secrets: post: operationId: importBitbucketSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Bitbucket Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Bitbucket. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/bitbucket/{syncId}/remove-secrets: post: operationId: removeBitbucketSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Bitbucket Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Bitbucket Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Bitbucket destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Bitbucket destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Bitbucket destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - bitbucket name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - bitbucket destinationConfig: type: object properties: repositorySlug: type: string description: The Bitbucket Repository slug to sync secrets to. environmentId: type: string description: The Bitbucket Deployment Environment uuid to sync secrets to. workspaceSlug: type: string description: The Bitbucket Workspace slug to sync secrets to. required: - repositorySlug - workspaceSlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Bitbucket required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge: get: operationId: listLaravelForgeSecretSyncs tags: - Secret Syncs description: List the Laravel Forge Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Laravel Forge Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createLaravelForgeSecretSync tags: - Secret Syncs description: Create a Laravel Forge Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Laravel Forge Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Laravel Forge Sync. connectionId: type: string format: uuid description: The ID of the Laravel Forge Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge/{syncId}: get: operationId: getLaravelForgeSecretSync tags: - Secret Syncs description: Get the specified Laravel Forge Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateLaravelForgeSecretSync tags: - Secret Syncs description: Update the specified Laravel Forge Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Laravel Forge Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Laravel Forge Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Laravel Forge Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteLaravelForgeSecretSync tags: - Secret Syncs description: Delete the specified Laravel Forge Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge/sync-name/{syncName}: get: operationId: getLaravelForgeSecretSyncByName tags: - Secret Syncs description: Get the specified Laravel Forge Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Laravel Forge Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Laravel Forge Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge/{syncId}/sync-secrets: post: operationId: syncLaravelForgeSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Laravel Forge Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge/{syncId}/import-secrets: post: operationId: importLaravelForgeSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Laravel Forge Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Laravel Forge. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/laravel-forge/{syncId}/remove-secrets: post: operationId: removeLaravelForgeSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Laravel Forge Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Laravel Forge Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Laravel Forge destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Laravel Forge destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Laravel Forge destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - laravel-forge name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - laravel-forge destinationConfig: type: object properties: orgSlug: type: string minLength: 1 maxLength: 512 description: The slug of the Laravel Forge org to sync secrets to. orgName: type: string description: The name of the Laravel Forge org to sync secrets to. serverId: type: string minLength: 1 description: The ID of the Laravel Forge server to sync secrets to. serverName: type: string description: The name of the Laravel Forge server to sync secrets to. siteId: type: string minLength: 1 description: The ID of the Laravel Forge site to sync secrets to. siteName: type: string description: The name of the Laravel Forge site to sync secrets to. required: - orgSlug - serverId - siteId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Laravel Forge required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef: get: operationId: listChefSecretSyncs tags: - Secret Syncs description: List the Chef Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Chef Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createChefSecretSync tags: - Secret Syncs description: Create a Chef Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Chef Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Chef Sync. connectionId: type: string format: uuid description: The ID of the Chef Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef/{syncId}: get: operationId: getChefSecretSync tags: - Secret Syncs description: Get the specified Chef Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateChefSecretSync tags: - Secret Syncs description: Update the specified Chef Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Chef Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Chef Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Chef Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteChefSecretSync tags: - Secret Syncs description: Delete the specified Chef Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef/sync-name/{syncName}: get: operationId: getChefSecretSyncByName tags: - Secret Syncs description: Get the specified Chef Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Chef Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Chef Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef/{syncId}/sync-secrets: post: operationId: syncChefSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Chef Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef/{syncId}/import-secrets: post: operationId: importChefSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Chef Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Chef. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/chef/{syncId}/remove-secrets: post: operationId: removeChefSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Chef Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Chef Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Chef destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Chef destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Chef destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - chef name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - chef destinationConfig: type: object properties: dataBagName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag to sync secrets to. dataBagItemName: type: string minLength: 1 maxLength: 256 description: The name of the Chef data bag item to sync secrets to. required: - dataBagName - dataBagItemName additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Chef required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy: get: operationId: listOctopusDeploySecretSyncs tags: - Secret Syncs description: List the Octopus Deploy Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Octopus Deploy Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createOctopusDeploySecretSync tags: - Secret Syncs description: Create an Octopus Deploy Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Octopus Deploy Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Octopus Deploy Sync. connectionId: type: string format: uuid description: The ID of the Octopus Deploy Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy/{syncId}: get: operationId: getOctopusDeploySecretSync tags: - Secret Syncs description: Get the specified Octopus Deploy Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateOctopusDeploySecretSync tags: - Secret Syncs description: Update the specified Octopus Deploy Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Octopus Deploy Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Octopus Deploy Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Octopus Deploy Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteOctopusDeploySecretSync tags: - Secret Syncs description: Delete the specified Octopus Deploy Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy/sync-name/{syncName}: get: operationId: getOctopusDeploySecretSyncByName tags: - Secret Syncs description: Get the specified Octopus Deploy Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Octopus Deploy Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Octopus Deploy Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy/{syncId}/sync-secrets: post: operationId: syncOctopusDeploySecretSync tags: - Secret Syncs description: Trigger a sync for the specified Octopus Deploy Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy/{syncId}/import-secrets: post: operationId: importOctopusDeploySecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Octopus Deploy Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Octopus Deploy. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/octopus-deploy/{syncId}/remove-secrets: post: operationId: removeOctopusDeploySecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Octopus Deploy Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Octopus Deploy Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Octopus Deploy destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Octopus Deploy destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Octopus Deploy destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - octopus-deploy name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - octopus-deploy destinationConfig: allOf: - type: object properties: spaceId: type: string minLength: 1 description: The ID of the Octopus Deploy space to sync secrets to. spaceName: type: string description: The name of the Octopus Deploy space to sync secrets to. scope: type: string enum: - project default: project required: - spaceId - anyOf: - type: object properties: scope: type: string enum: - project projectId: type: string minLength: 1 description: The ID of the Octopus Deploy project to sync secrets to. projectName: type: string description: The name of the Octopus Deploy project to sync secrets to. scopeValues: type: object properties: environments: type: array items: type: string roles: type: array items: type: string machines: type: array items: type: string processes: type: array items: type: string actions: type: array items: type: string channels: type: array items: type: string additionalProperties: false description: The Octopus Deploy scope values that secrets should be synced to. required: - scope - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Octopus Deploy required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci: get: operationId: listCircleciSecretSyncs tags: - Secret Syncs description: List the CircleCI Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list CircleCI Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createCircleciSecretSync tags: - Secret Syncs description: Create a CircleCI Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the CircleCI Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the CircleCI Sync. connectionId: type: string format: uuid description: The ID of the CircleCI Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgName: type: string minLength: 1 description: The CircleCI organization name to sync secrets to. projectName: type: string minLength: 1 description: The CircleCI project name to sync secrets to. projectId: type: string minLength: 1 description: The CircleCI project ID to sync secrets to. required: - orgName - projectName - projectId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci/{syncId}: get: operationId: getCircleciSecretSync tags: - Secret Syncs description: Get the specified CircleCI Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateCircleciSecretSync tags: - Secret Syncs description: Update the specified CircleCI Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the CircleCI Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the CircleCI Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the CircleCI Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteCircleciSecretSync tags: - Secret Syncs description: Delete the specified CircleCI Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci/sync-name/{syncName}: get: operationId: getCircleciSecretSyncByName tags: - Secret Syncs description: Get the specified CircleCI Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the CircleCI Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the CircleCI Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci/{syncId}/sync-secrets: post: operationId: syncCircleciSecretSync tags: - Secret Syncs description: Trigger a sync for the specified CircleCI Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci/{syncId}/import-secrets: post: operationId: importCircleciSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified CircleCI Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or CircleCI. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/circleci/{syncId}/remove-secrets: post: operationId: removeCircleciSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified CircleCI Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the CircleCI Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the CircleCI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the CircleCI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the CircleCI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - circleci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - circleci destinationConfig: type: object properties: orgName: type: string minLength: 1 projectName: type: string minLength: 1 projectId: type: string minLength: 1 required: - orgName - projectName - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: CircleCI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim: get: operationId: listAzureEntraIdScimSecretSyncs tags: - Secret Syncs description: List the Azure Entra ID SCIM Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Azure Entra ID SCIM Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createAzureEntraIdScimSecretSync tags: - Secret Syncs description: Create an Azure Entra ID SCIM Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Azure Entra ID SCIM Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Azure Entra ID SCIM Sync. connectionId: type: string format: uuid description: The ID of the Azure Entra ID Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretKey: type: string minLength: 1 description: The key of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior - secretKey additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim/{syncId}: get: operationId: getAzureEntraIdScimSecretSync tags: - Secret Syncs description: Get the specified Azure Entra ID SCIM Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateAzureEntraIdScimSecretSync tags: - Secret Syncs description: Update the specified Azure Entra ID SCIM Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Azure Entra ID SCIM Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Azure Entra ID Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Azure Entra ID SCIM Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretKey: type: string minLength: 1 description: The key of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteAzureEntraIdScimSecretSync tags: - Secret Syncs description: Delete the specified Azure Entra ID SCIM Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim/sync-name/{syncName}: get: operationId: getAzureEntraIdScimSecretSyncByName tags: - Secret Syncs description: Get the specified Azure Entra ID SCIM Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Azure Entra ID SCIM Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Azure Entra ID SCIM Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim/{syncId}/sync-secrets: post: operationId: syncAzureEntraIdScimSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Azure Entra ID SCIM Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim/{syncId}/import-secrets: post: operationId: importAzureEntraIdScimSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Azure Entra ID SCIM Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Azure Entra ID SCIM. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/azure-entra-id-scim/{syncId}/remove-secrets: post: operationId: removeAzureEntraIdScimSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Azure Entra ID SCIM Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Azure Entra ID SCIM Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Azure Entra ID SCIM destination. keySchema: type: string description: Not supported for Azure Entra ID SCIM syncs. disableSecretDeletion: anyOf: - type: boolean enum: - false - not: {} description: Not supported for Azure Entra ID SCIM syncs. secretId: type: string format: uuid description: The ID of the Infisical secret whose value will be used as the SCIM provisioning token. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - azure-entra-id name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - azure-entra-id-scim destinationConfig: type: object properties: servicePrincipalId: type: string format: uuid minLength: 1 description: The Object ID of the Azure Entra ID Enterprise Application service principal to sync the SCIM token to. servicePrincipalDisplayName: type: string description: The display name of the Azure Entra ID Enterprise Application service principal. required: - servicePrincipalId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Azure Entra ID SCIM required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical: get: operationId: listExternalInfisicalSecretSyncs tags: - Secret Syncs description: List the Infisical Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Infisical Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createExternalInfisicalSecretSync tags: - Secret Syncs description: Create an Infisical Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Infisical Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Infisical Sync. connectionId: type: string format: uuid description: The ID of the Infisical Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical/{syncId}: get: operationId: getExternalInfisicalSecretSync tags: - Secret Syncs description: Get the specified Infisical Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateExternalInfisicalSecretSync tags: - Secret Syncs description: Update the specified Infisical Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Infisical Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Infisical Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Infisical Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteExternalInfisicalSecretSync tags: - Secret Syncs description: Delete the specified Infisical Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical/sync-name/{syncName}: get: operationId: getExternalInfisicalSecretSyncByName tags: - Secret Syncs description: Get the specified Infisical Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Infisical Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Infisical Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical/{syncId}/sync-secrets: post: operationId: syncExternalInfisicalSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Infisical Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical/{syncId}/import-secrets: post: operationId: importExternalInfisicalSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Infisical Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Infisical. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/external-infisical/{syncId}/remove-secrets: post: operationId: removeExternalInfisicalSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Infisical Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Infisical Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the Infisical destination. keySchema: type: string description: Not supported for Infisical syncs. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Infisical destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - external-infisical name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - external-infisical destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The ID of the project on the external Infisical instance to sync secrets to. environment: type: string minLength: 1 description: The environment slug on the external Infisical instance to sync secrets to. secretPath: type: string minLength: 1 description: The secret path on the external Infisical instance to sync secrets to. required: - projectId - environment - secretPath additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Infisical required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh: get: operationId: listOvhSecretSyncs tags: - Secret Syncs description: List the OVH Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list OVH Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createOvhSecretSync tags: - Secret Syncs description: Create an OVH Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the OVH Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the OVH Sync. connectionId: type: string format: uuid description: The ID of the OVH Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh/{syncId}: get: operationId: getOvhSecretSync tags: - Secret Syncs description: Get the specified OVH Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateOvhSecretSync tags: - Secret Syncs description: Update the specified OVH Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the OVH Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the OVH Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the OVH Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteOvhSecretSync tags: - Secret Syncs description: Delete the specified OVH Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh/sync-name/{syncName}: get: operationId: getOvhSecretSyncByName tags: - Secret Syncs description: Get the specified OVH Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the OVH Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the OVH Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh/{syncId}/sync-secrets: post: operationId: syncOvhSecretSync tags: - Secret Syncs description: Trigger a sync for the specified OVH Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh/{syncId}/import-secrets: post: operationId: importOvhSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified OVH Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or OVH. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ovh/{syncId}/remove-secrets: post: operationId: removeOvhSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified OVH Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the OVH Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination - import-prioritize-source - import-prioritize-destination description: Specify how Infisical should resolve the initial sync to the OVH destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the OVH destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the OVH destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ovh name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ovh destinationConfig: type: object properties: path: type: string minLength: 1 maxLength: 128 description: The path in OVH OKMS where secrets will be stored as key/value pairs. required: - path additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: OVH required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin: get: operationId: listDevinSecretSyncs tags: - Secret Syncs description: List the Devin Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Devin Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createDevinSecretSync tags: - Secret Syncs description: Create a Devin Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Devin Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Devin Sync. connectionId: type: string format: uuid description: The ID of the Devin Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin/{syncId}: get: operationId: getDevinSecretSync tags: - Secret Syncs description: Get the specified Devin Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateDevinSecretSync tags: - Secret Syncs description: Update the specified Devin Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Devin Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Devin Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Devin Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteDevinSecretSync tags: - Secret Syncs description: Delete the specified Devin Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin/sync-name/{syncName}: get: operationId: getDevinSecretSyncByName tags: - Secret Syncs description: Get the specified Devin Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Devin Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Devin Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin/{syncId}/sync-secrets: post: operationId: syncDevinSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Devin Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin/{syncId}/import-secrets: post: operationId: importDevinSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Devin Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Devin. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/devin/{syncId}/remove-secrets: post: operationId: removeDevinSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Devin Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Devin Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Devin destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Devin destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Devin destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - devin name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - devin destinationConfig: type: object properties: orgId: type: string minLength: 1 pattern: ^org\- description: The Devin organization ID to sync secrets to. required: - orgId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Devin required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona: get: operationId: listOnaSecretSyncs tags: - Secret Syncs description: List the Ona Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Ona Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createOnaSecretSync tags: - Secret Syncs description: Create an Ona Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Ona Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Ona Sync. connectionId: type: string format: uuid description: The ID of the Ona Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona/{syncId}: get: operationId: getOnaSecretSync tags: - Secret Syncs description: Get the specified Ona Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateOnaSecretSync tags: - Secret Syncs description: Update the specified Ona Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Ona Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Ona Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Ona Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteOnaSecretSync tags: - Secret Syncs description: Delete the specified Ona Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona/sync-name/{syncName}: get: operationId: getOnaSecretSyncByName tags: - Secret Syncs description: Get the specified Ona Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Ona Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Ona Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona/{syncId}/sync-secrets: post: operationId: syncOnaSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Ona Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona/{syncId}/import-secrets: post: operationId: importOnaSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Ona Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Ona. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/ona/{syncId}/remove-secrets: post: operationId: removeOnaSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Ona Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Ona Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Ona destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Ona destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Ona destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - ona name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - ona destinationConfig: type: object properties: projectId: type: string minLength: 1 description: The Ona project ID to sync secrets to. projectName: type: string description: An optional display name for the Ona project. required: - projectId additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Ona required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci: get: operationId: listTravisCISecretSyncs tags: - Secret Syncs description: List the Travis CI Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Travis CI Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createTravisCISecretSync tags: - Secret Syncs description: Create a Travis CI Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Travis CI Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Travis CI Sync. connectionId: type: string format: uuid description: The ID of the Travis CI Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci/{syncId}: get: operationId: getTravisCISecretSync tags: - Secret Syncs description: Get the specified Travis CI Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateTravisCISecretSync tags: - Secret Syncs description: Update the specified Travis CI Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Travis CI Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Travis CI Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Travis CI Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteTravisCISecretSync tags: - Secret Syncs description: Delete the specified Travis CI Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci/sync-name/{syncName}: get: operationId: getTravisCISecretSyncByName tags: - Secret Syncs description: Get the specified Travis CI Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Travis CI Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Travis CI Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci/{syncId}/sync-secrets: post: operationId: syncTravisCISecretSync tags: - Secret Syncs description: Trigger a sync for the specified Travis CI Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci/{syncId}/import-secrets: post: operationId: importTravisCISecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Travis CI Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Travis CI. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/travis-ci/{syncId}/remove-secrets: post: operationId: removeTravisCISecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Travis CI Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Travis CI Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Travis CI destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Travis CI destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Travis CI destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - travis-ci name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - travis-ci destinationConfig: type: object properties: repositoryId: type: string minLength: 1 description: The ID of the Travis CI repository to sync secrets to. repositorySlug: type: string minLength: 1 description: The slug (owner/repo) of the Travis CI repository to sync secrets to. branch: type: string minLength: 1 description: The branch of the Travis CI repository to sync secrets to. If omitted, secrets sync to the repository-level scope. required: - repositoryId - repositorySlug additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Travis CI required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake: get: operationId: listSnowflakeSecretSyncs tags: - Secret Syncs description: List the Snowflake Syncs for the specified project. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project to list Snowflake Syncs from. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSyncs: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSyncs additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: operationId: createSnowflakeSecretSync tags: - Secret Syncs description: Create a Snowflake Sync for the specified project environment. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The name of the Snowflake Sync to create. Must be slug-friendly. projectId: type: string minLength: 1 description: The ID of the project to create the sync in. description: type: string maxLength: 256 nullable: true description: An optional description for the Snowflake Sync. connectionId: type: string format: uuid description: The ID of the Snowflake Connection to use for syncing. environment: type: string minLength: 1 maxLength: 64 description: The slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The folder path to sync secrets from. isAutoSyncEnabled: type: boolean default: true description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - name - projectId - connectionId - environment - secretPath - syncOptions - destinationConfig additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake/{syncId}: get: operationId: getSnowflakeSecretSync tags: - Secret Syncs description: Get the specified Snowflake Sync by ID. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateSnowflakeSecretSync tags: - Secret Syncs description: Update the specified Snowflake Sync. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 256 description: The updated name of the Snowflake Sync. Must be slug-friendly. connectionId: type: string format: uuid description: The updated ID of the Snowflake Connection to use for syncing. description: type: string maxLength: 256 nullable: true description: The updated description of the Snowflake Sync. environment: type: string minLength: 1 maxLength: 64 description: The updated slug of the project environment to sync secrets from. secretPath: type: string minLength: 1 description: The updated folder path to sync secrets from. isAutoSyncEnabled: type: boolean description: Whether secrets should be automatically synced when changes occur at the source location or not. syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false additionalProperties: false parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteSnowflakeSecretSync tags: - Secret Syncs description: Delete the specified Snowflake Sync. parameters: - schema: type: string enum: - 'true' - 'false' default: 'false' in: query name: removeSecrets required: false description: Whether previously synced secrets should be removed prior to deletion. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake/sync-name/{syncName}: get: operationId: getSnowflakeSecretSyncByName tags: - Secret Syncs description: Get the specified Snowflake Sync by name and project ID. parameters: - schema: type: string minLength: 1 in: query name: projectId required: true description: The ID of the project the Snowflake Sync is associated with. - schema: type: string minLength: 1 in: path name: syncName required: true description: The name of the Snowflake Sync to retrieve. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake/{syncId}/sync-secrets: post: operationId: syncSnowflakeSecretSync tags: - Secret Syncs description: Trigger a sync for the specified Snowflake Sync. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to trigger a sync for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake/{syncId}/import-secrets: post: operationId: importSnowflakeSecretSyncSecrets tags: - Secret Syncs description: Import secrets from the specified Snowflake Sync destination. parameters: - schema: type: string enum: - prioritize-source - prioritize-destination in: query name: importBehavior required: true description: Specify whether Infisical should prioritize secret values from Infisical or Snowflake. - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to trigger importing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/secret-syncs/snowflake/{syncId}/remove-secrets: post: operationId: removeSnowflakeSecretSyncSecrets tags: - Secret Syncs description: Remove previously synced secrets from the specified Snowflake Sync destination. parameters: - schema: type: string format: uuid in: path name: syncId required: true description: The ID of the Snowflake Sync to trigger removing secrets for. responses: '200': description: Default Response content: application/json: schema: type: object properties: secretSync: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true isAutoSyncEnabled: type: boolean default: true version: type: number default: 1 projectId: type: string folderId: type: string format: uuid nullable: true connectionId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time syncStatus: type: string nullable: true lastSyncJobId: type: string nullable: true lastSyncMessage: type: string nullable: true lastSyncedAt: type: string format: date-time nullable: true importStatus: type: string nullable: true lastImportJobId: type: string nullable: true lastImportMessage: type: string nullable: true lastImportedAt: type: string format: date-time nullable: true removeStatus: type: string nullable: true lastRemoveJobId: type: string nullable: true lastRemoveMessage: type: string nullable: true lastRemovedAt: type: string format: date-time nullable: true syncOptions: type: object properties: initialSyncBehavior: type: string enum: - overwrite-destination description: Specify how Infisical should resolve the initial sync to the Snowflake destination. keySchema: type: string description: Specify the format to use for structuring secret keys in the Snowflake destination. disableSecretDeletion: type: boolean description: Enable this flag to prevent removal of secrets from the Snowflake destination when syncing. required: - initialSyncBehavior additionalProperties: false description: Optional parameters to modify how secrets are synced. connection: type: object properties: app: type: string enum: - snowflake name: type: string id: type: string format: uuid required: - app - name - id additionalProperties: false environment: type: object properties: slug: type: string name: type: string id: type: string format: uuid required: - slug - name - id additionalProperties: false nullable: true folder: type: object properties: id: type: string path: type: string required: - id - path additionalProperties: false nullable: true destination: type: string enum: - snowflake destinationConfig: type: object properties: database: type: string minLength: 1 description: The name of the Snowflake database to sync secrets to. schema: type: string minLength: 1 description: The name of the Snowflake schema (within the database) to sync secrets to. required: - database - schema additionalProperties: false required: - id - name - projectId - connectionId - createdAt - updatedAt - syncOptions - connection - environment - folder - destination - destinationConfig additionalProperties: false title: Snowflake required: - secretSync additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: An access token in Infisical