> ## Documentation Index
> Fetch the complete documentation index at: https://infisical.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Octopus Deploy Sync

> Learn how to configure an Octopus Deploy Sync for Infisical.

**Prerequisites:**

* Create an [Octopus Deploy Connection](/integrations/app-connections/octopus-deploy)

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

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/general/secret-sync-tab.png" alt="Secret Syncs Tab" />
      </Step>

      <Step title="Select 'Octopus Deploy'">
        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/select-option.png" alt="Select Octopus Deploy" />
      </Step>

      <Step title="Configure source">
        Configure the **Source** from where secrets should be retrieved, then click **Next**.

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-source.png" alt="Configure Source" />

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

        The destination configuration is organized into two tabs:

        **General Tab:**

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-destination.png" alt="Configure Destination" />

        * **Octopus Deploy Connection**: The Octopus Deploy Connection to authenticate with.
        * **Space**: The Octopus Deploy Space to sync secrets to.
        * **Project**: The Octopus Deploy Project within the Space to sync secrets to.

        **Advanced Tab:**

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-destination-advanced.png" alt="Configure Destination Advanced" />

        The Advanced tab allows you to specify optional scope values to restrict where the synced variables are available within your Octopus Deploy project:

        * **Environments**: Restrict variables to specific environments (e.g., Development, Staging, Production).
        * **Target Tags**: Restrict variables to specific target tags (e.g., web-server, database).
        * **Targets**: Restrict variables to specific deployment targets.
        * **Processes**: Restrict variables to specific deployment processes.
        * **Deployment Steps**: Restrict variables to specific deployment steps.
        * **Channels**: Restrict variables to specific release channels.
      </Step>

      <Step title="Configure Sync Options">
        Configure the **Sync Options** to specify how secrets should be synced, then click **Next**.

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-options.png" alt="Configure Options" />

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

        <Note>
          Octopus Deploy does not support importing secrets.
        </Note>

        * **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 Octopus Deploy Sync, then click **Next**.

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-details.png" alt="Configure Details" />

        * **Name**: The name of your sync. Must be slug-friendly.
        * **Description**: An optional description for your sync.
      </Step>

      <Step title="Review configuration">
        Review your Octopus Deploy Sync configuration, then click **Create Sync**.

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-review.png" alt="Review Configuration" />
      </Step>

      <Step title="Sync created">
        If enabled, your Octopus Deploy Sync will begin syncing your secrets to the destination endpoint.

        <img src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/images/secret-syncs/octopus-deploy/sync-created.png" alt="Sync Created" />
      </Step>
    </Steps>
  </Tab>

  <Tab title="API">
    To create an **Octopus Deploy Sync**, make an API request to the [Create Octopus Deploy Sync](/api-reference/endpoints/secret-syncs/octopus-deploy/create) API endpoint.

    ### Sample request

    ```bash Request theme={"dark"}
    curl    --request POST \
            --url https://app.infisical.com/api/v1/secret-syncs/octopus-deploy \
            --header 'Content-Type: application/json' \
            --data '{
                "name": "my-octopus-deploy-sync",
                "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "description": "sync to octopus deploy project",
                "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "environment": "dev",
                "secretPath": "/",
                "isEnabled": true,
                "isAutoSyncEnabled": true,
                "syncOptions": {
                    "initialSyncBehavior": "overwrite-destination",
                    "disableSecretDeletion": false
                },
                "destinationConfig": {
                    "spaceId": "Spaces-1",
                    "scope": "project",
                    "projectId": "Projects-123",
                    "scopeValues": {
                        "environments": ["Environments-1", "Environments-2"],
                        "roles": ["web-server"],
                        "channels": ["Channels-1"]
                    }
                }
            }'
    ```

    ### Sample response

    ```json Response theme={"dark"}
        {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-octopus-deploy-secret-sync",
        "description": null,
        "isAutoSyncEnabled": true,
        "version": 1,
        "projectId": "1e812ad3-e5df-4f1b-839d-13b4ef201840",
        "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2025-12-12T09:44:59.023Z",
        "updatedAt": "2025-12-12T09:44:59.023Z",
        "syncStatus": "succeeded",
        "lastSyncJobId": null,
        "lastSyncMessage": null,
        "lastSyncedAt": null,
        "importStatus": null,
        "lastImportJobId": null,
        "lastImportMessage": null,
        "lastImportedAt": null,
        "removeStatus": null,
        "lastRemoveJobId": null,
        "lastRemoveMessage": null,
        "lastRemovedAt": null,
        "syncOptions": {
            "initialSyncBehavior": "overwrite-destination",
            "disableSecretDeletion": false
        },
        "connection": {
            "app": "octopus-deploy",
            "name": "my-octopus-deploy-connection",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "environment": {
            "slug": "dev",
            "name": "Development",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "folder": {
            "id": "ad9c26ed-a7ee-41f4-b883-8dd25736052a",
            "path": "/"
        },
        "destination": "octopus-deploy",
        "destinationConfig": {
            "spaceId": "Spaces-1",
            "scope": "project",
            "projectId": "Projects-1",
            "scopeValues": {
                "environments": [
                    "Environments-1",
                    "Environments-2"
                ],
                "roles": [
                    "sample-app-server"
                ],
                "machines": [
                    "Machines-1",
                    "Machines-2"
                ],
                "processes": [
                    "Runbooks-1",
                    "Runbooks-2"
                ],
                "actions": [
                    "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                ],
                "channels": [
                    "Channels-2",
                    "Channels-1"
                ]
            }
        }
    }
    ```
  </Tab>
</Tabs>