awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Bitbucket Secret Sync

Browse Source
This commit is contained in:
Carlos Monastyrski
2025-07-21 10:28:31 -03:00
parent 9674b71df8
commit d44b3293b6
54 changed files with 1176 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-reference/endpoints/secret-syncs/bitbucket/create.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Create"
openapi: "POST /api/v1/secret-syncs/bitbucket"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/delete.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Delete"
openapi: "DELETE /api/v1/secret-syncs/bitbucket/{syncId}"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/get-by-id.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by ID"
openapi: "GET /api/v1/secret-syncs/bitbucket/{syncId}"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/get-by-name.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Get by Name"
openapi: "GET /api/v1/secret-syncs/bitbucket/sync-name/{syncName}"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/import-secrets.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Import Secrets"
openapi: "POST /api/v1/secret-syncs/bitbucket/{syncId}/import-secrets"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/list.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "List"
openapi: "GET /api/v1/secret-syncs/bitbucket"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/remove-secrets.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Remove Secrets"
openapi: "POST /api/v1/secret-syncs/bitbucket/{syncId}/remove-secrets"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/sync-secrets.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Sync Secrets"
openapi: "POST /api/v1/secret-syncs/bitbucket/{syncId}/sync-secrets"
---

4
docs/api-reference/endpoints/secret-syncs/bitbucket/update.mdx Normal file
View File

@@ -0,0 +1,4 @@
---
title: "Update"
openapi: "PATCH /api/v1/secret-syncs/bitbucket/{syncId}"
---

15
docs/docs.json
View File

@@ -508,6 +508,7 @@
"integrations/secret-syncs/azure-app-configuration",
"integrations/secret-syncs/azure-devops",
"integrations/secret-syncs/azure-key-vault",
"integrations/secret-syncs/bitbucket",
"integrations/secret-syncs/camunda",
"integrations/secret-syncs/checkly",
"integrations/secret-syncs/cloudflare-pages",
@@ -1707,6 +1708,20 @@
"api-reference/endpoints/secret-syncs/azure-key-vault/remove-secrets"
]
},
{
"group": "Bitbucket",
"pages": [
"api-reference/endpoints/secret-syncs/bitbucket/list",
"api-reference/endpoints/secret-syncs/bitbucket/get-by-id",
"api-reference/endpoints/secret-syncs/bitbucket/get-by-name",
"api-reference/endpoints/secret-syncs/bitbucket/create",
"api-reference/endpoints/secret-syncs/bitbucket/update",
"api-reference/endpoints/secret-syncs/bitbucket/delete",
"api-reference/endpoints/secret-syncs/bitbucket/sync-secrets",
"api-reference/endpoints/secret-syncs/bitbucket/import-secrets",
"api-reference/endpoints/secret-syncs/bitbucket/remove-secrets"
]
},
{
"group": "Camunda",
"pages": [

BIN
docs/images/secret-syncs/bitbucket/configure-destination.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 563 KiB

BIN
docs/images/secret-syncs/bitbucket/configure-details.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 541 KiB

BIN
docs/images/secret-syncs/bitbucket/configure-source.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 532 KiB

BIN
docs/images/secret-syncs/bitbucket/configure-sync-options.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 580 KiB

BIN
docs/images/secret-syncs/bitbucket/review-configuration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 581 KiB

BIN
docs/images/secret-syncs/bitbucket/select-option.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 613 KiB

BIN
docs/images/secret-syncs/bitbucket/sync-created.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 927 KiB

158
docs/integrations/secret-syncs/bitbucket.mdx Normal file
View File

@@ -0,0 +1,158 @@
---
title: "Bitbucket Sync"
description: "Learn how to configure a Bitbucket Sync for Infisical."
---
**Prerequisites:**
- Create a [Bitbucket Connection](/integrations/app-connections/bitbucket)
<Tabs>
<Tab title="Infisical UI">
<Steps>
<Step title="Add Sync">
Navigate to **Project** > **Integrations** and select the **Secret Syncs** tab. Click on the **Add Sync** button.
![Secret Syncs Tab](/images/secret-syncs/general/secret-sync-tab.png)
</Step>
<Step title="Select 'Bitbucket'">
![Select Bitbucket](/images/secret-syncs/bitbucket/select-option.png)
</Step>
<Step title="Configure source">
Configure the **Source** from where secrets should be retrieved, then click **Next**.
![Configure Source](/images/secret-syncs/bitbucket/configure-source.png)
- **Environment**: The project environment to retrieve secrets from.
- **Secret Path**: The folder path to retrieve secrets from.
<Tip>
If you need to sync secrets from multiple folder locations, check out [secret imports](/documentation/platform/secret-reference#secret-imports).
</Tip>
</Step>
<Step title="Configure destination">
Configure the **Destination** to where secrets should be deployed, then click **Next**.
![Configure Destination](/images/secret-syncs/bitbucket/configure-destination.png)
- **Bitbucket Connection**: The Bitbucket Connection to authenticate with.
- **Workspace**: The Bitbucket workspace to sync secrets to.
- **Repository**: The Bitbucket repository to sync secrets to.
- **Deployment Environment (Optional)**: The Bitbucket deployment environment to sync secrets to.
</Step>
<Step title="Configure sync options">
Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.
![Configure Sync Options](/images/secret-syncs/bitbucket/configure-sync-options.png)
- **Initial Sync Behavior**: Determines how Infisical should resolve the initial sync.
- **Overwrite Destination Secrets**: Removes any secrets at the destination endpoint not present in Infisical.
- **Import Secrets (Prioritize Infisical)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Infisical over Bitbucket when keys conflict.
- **Import Secrets (Prioritize Bitbucket)**: Imports secrets from the destination endpoint before syncing, prioritizing values from Bitbucket over Infisical when keys conflict.
- **Key Schema**: Template that determines how secret names are transformed when syncing, using `{{secretKey}}` as a placeholder for the original secret name and `{{environment}}` for the environment.
<Note>
We highly recommend using a Key Schema to ensure that Infisical only manages the specific keys you intend, keeping everything else untouched.
</Note>
- **Auto-Sync Enabled**: If enabled, secrets will automatically be synced from the source location when changes occur. Disable to enforce manual syncing only.
- **Disable Secret Deletion**: If enabled, Infisical will not remove secrets from the sync destination. Enable this option if you intend to manage some secrets manually outside of Infisical.
</Step>
<Step title="Configure details">
Configure the **Details** of your Bitbucket Sync, then click **Next**.
![Configure Details](/images/secret-syncs/bitbucket/configure-details.png)
- **Name**: The name of your sync. Must be slug-friendly.
- **Description**: An optional description for your sync.
</Step>
<Step title="Review configuration">
Review your Bitbucket Sync configuration, then click **Create Sync**.
![Review Configuration](/images/secret-syncs/bitbucket/review-configuration.png)
</Step>
<Step title="Sync created">
If enabled, your Bitbucket Sync will begin syncing your secrets to the destination endpoint.
![Sync Created](/images/secret-syncs/bitbucket/sync-created.png)
</Step>
</Steps>
</Tab>
<Tab title="API">
To create a **Bitbucket Sync**, make an API request to the [Create Bitbucket Sync](/api-reference/endpoints/secret-syncs/bitbucket/create) API endpoint.
### Sample request
```bash Request
curl --request POST \
--url https://app.infisical.com/api/v1/secret-syncs/bitbucket \
--header 'Content-Type: application/json' \
--data '{
"name": "my-bitbucket-sync",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "an example sync",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment": "dev",
"secretPath": "/my-secrets",
"isEnabled": true,
"syncOptions": {
"initialSyncBehavior": "overwrite-destination"
},
"destinationConfig": {
"workspace": "...",
"repository": "..."
}
}'
```
### Sample response
```bash Response
{
"secretSync": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "my-bitbucket-sync",
"description": "an example sync",
"isEnabled": true,
"version": 1,
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"syncStatus": "succeeded",
"lastSyncJobId": "123",
"lastSyncMessage": null,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"importStatus": null,
"lastImportJobId": null,
"lastImportMessage": null,
"lastImportedAt": null,
"removeStatus": null,
"lastRemoveJobId": null,
"lastRemoveMessage": null,
"lastRemovedAt": null,
"syncOptions": {
"initialSyncBehavior": "overwrite-destination"
},
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connection": {
"app": "bitbucket",
"name": "my-bitbucket-connection",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"environment": {
"slug": "dev",
"name": "Development",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "/my-secrets"
},
"destination": "bitbucket",
"destinationConfig": {
"workspace": "...",
"repository": "..."
}
}
}
```
</Tab>
</Tabs>