Skip to main content

Using Secrets

Learn how to reference your workspace secrets in Ductape configurations using the $Secret{} syntax.

The $Secret Syntax​

Ductape provides a special syntax to reference secrets in your configurations without exposing the actual values. When you use $Secret{key}, Ductape automatically resolves and decrypts the secret at runtime.

Basic Usage​

$Secret{SECRET_KEY}

Replace SECRET_KEY with the key of your secret (the exact key you used when creating the secret).

Where to Use Secrets​

In App Authentication​

Reference secrets when configuring app authentication:

await ductape.product.apps.add({
  access_tag: 'stripe_app',
  envs: [
    {
      app_env_slug: 'prd',
      product_env_slug: 'prd',
      variables: [],
      auth: [
        {
          auth_tag: 'api_key_auth',
          data: {
            api_key: '$Secret{STRIPE_API_KEY}'  // Secret reference
          }
        }
      ]
    }
  ]
});

In Environment Variables​

Use secrets in app environment variables:

await ductape.product.apps.add({
  access_tag: 'email_service',
  envs: [
    {
      app_env_slug: 'prd',
      product_env_slug: 'prd',
      variables: [
        { key: 'SENDGRID_KEY', value: '$Secret{SENDGRID_API_KEY}' },
        { key: 'FROM_EMAIL', value: 'noreply@example.com' }
      ],
      auth: []
    }
  ]
});

In Action Headers​

Reference secrets in custom headers:

const result = await ductape.api.run({
  app: 'custom_api',
  event: 'fetch_data',
  input: {
    headers: {
      'X-API-Key': '$Secret{CUSTOM_API_KEY}',
      'X-Webhook-Secret': '$Secret{WEBHOOK_SIGNING_SECRET}'
    },
    body: {
      data: 'payload'
    }
  }
});

In Webhook Configurations​

Secure your webhooks with secret references:

await ductape.product.webhooks.create({
  name: 'GitHub Webhook',
  tag: 'github_webhook',
  signing_secret: '$Secret{GITHUB_WEBHOOK_SECRET}',
  // ... other configuration
});

Copying Secret References​

In the Ductape Workbench, you can quickly copy the token reference syntax:

  1. Navigate to Workspace Settings > Secrets
  2. Find the secret you want to reference
  3. Click the copy icon next to the secret name
  4. The $Secret{SECRET_KEY} syntax is copied to your clipboard
  5. Paste it wherever you need to use the secret

Runtime Resolution​

When Ductape processes a configuration containing $Secret{} references:

  1. Detection: The system identifies all $Secret{} patterns
  2. Validation: Checks if the referenced secrets exist and are accessible
  3. Scope Check: Verifies the secret's scope includes the current app
  4. Environment Check: Confirms the secret is available in the current environment
  5. Decryption: Retrieves and decrypts the secret value
  6. Substitution: Replaces the $Secret{} reference with the actual value

Scope and Environment Restrictions​

Secrets respect their scope and environment restrictions at runtime:

Scope Example​

// Secret created with limited scope
await ductape.secrets.create({
  key: 'STRIPE_KEY',
  value: 'Bearer sk_live_xxx',
  scope: ['payment_app']  // Only accessible by payment_app
});

// This works - payment_app is in scope
await ductape.api.run({
  app: 'payment_app',
  // ...
  input: {
    headers: { 'Authorization': '$Secret{STRIPE_KEY}' }
  }
});

// This fails - analytics_app is not in scope
await ductape.api.run({
  app: 'analytics_app',
  // ...
  input: {
    headers: { 'Authorization': '$Secret{STRIPE_KEY}' }  // Error!
  }
});

Environment Example​

// Secret created for production only
await ductape.secrets.create({
  key: 'PROD_DATABASE_URL',
  value: 'postgres://prod-server/db',
  envs: ['prd']
});

// This works - running in production
await ductape.api.run({
  // ...
});

// This fails - secret not available in dev
await ductape.api.run({
  // ...
  input: {
    body: { db_url: '$Secret{PROD_DATABASE_URL}' }  // Error!
  }
});

Multiple Secrets in One Configuration​

You can use multiple secret references in the same configuration:

await ductape.product.apps.add({
  access_tag: 'multi_service_app',
  envs: [
    {
      app_env_slug: 'prd',
      product_env_slug: 'prd',
      variables: [
        { key: 'DB_HOST', value: '$Secret{DATABASE_HOST}' },
        { key: 'DB_USER', value: '$Secret{DATABASE_USER}' },
        { key: 'DB_PASS', value: '$Secret{DATABASE_PASSWORD}' },
        { key: 'REDIS_URL', value: '$Secret{REDIS_CONNECTION_STRING}' },
        { key: 'S3_KEY', value: '$Secret{AWS_ACCESS_KEY}' },
        { key: 'S3_SECRET', value: '$Secret{AWS_SECRET_KEY}' }
      ],
      auth: [
        {
          auth_tag: 'oauth',
          data: {
            client_id: '$Secret{OAUTH_CLIENT_ID}',
            client_secret: '$Secret{OAUTH_CLIENT_SECRET}'
          }
        }
      ]
    }
  ]
});

Troubleshooting​

Secret Not Found​

Error: Secret 'MY_SECRET' not found

Solution: Verify the secret exists in your workspace and the key is spelled correctly (case-sensitive).

Scope Mismatch​

Error: Secret 'STRIPE_KEY' is not accessible by app 'other_app'

Solution: Update the secret's scope to include the app, or use a different secret.

Environment Mismatch​

Error: Secret 'PROD_KEY' is not available in environment 'dev'

Solution: Update the secret's envs array to include the environment, or use an environment-specific secret.

Expired Secret​

Error: Secret 'OLD_KEY' has expired

Solution: Update the secret with a new value and expiration date, or create a new secret.

Security Considerations​

  1. Never log secret values: Avoid logging configurations that contain resolved secrets
  2. Use narrow scopes: Only grant access to apps that genuinely need the secret
  3. Set expirations: Use expires_at to enforce regular rotation
  4. Audit usage: Review which apps and environments use each secret
  5. Rotate compromised secrets: If a secret is exposed, immediately update or delete it

Next Steps​