Import and Export Automations

The Import and Export Automations feature in Red Canary allows you to extract existing automation configurations from a specific subdomain, save them in a YAML file, and transfer to another subdomain. This eliminates the need for manual setup of triggers and playbooks, allowing you to easily scale your automation.

Exporting Automations

Note

This feature has the following limitations:

• Only active triggers and playbooks are included in the export.

• Playbooks are only included if they’re linked to an active trigger.

• Playbooks managed by Red Canary, such as those utilized by the Active Remediation team, are excluded even if they’re active.

To export the automation:

1. In your Red Canary portal, navigate to the Automation page.

2. Click Export Automation. The YAML file will be emailed to the email address associated with your Red Canary user account.
   

Importing Automations

Note

• Before importing, we recommend reviewing the contents of the YAML file to avoid errors or overwriting unintended automation rules.

• Red Canary will not recognize duplicative automations. If you happen to upload the same automation twice, the automation will be duplicated. This won’t cause any issues from a technical perspective, but it will potentially create clutter that’ll need to be cleaned up.

To import the automation:

1. Download the YAML file Red Canary sent to the email associated with your account.

2. In your Red Canary portal, navigate to the desired subdomain.

3. Click Import Automation.

4. (Optional) Click the checkbox Deactivate all existing automations before importing. If you don’t enable this option, existing automations in the subdomain will remain untouched and will coexist with the imported automations.

5. Upload the YAML file and click Save.
   

Red Canary will send a confirmation email that contains:

• A status update (successful or unsuccessful).

• A detailed count of how many records were successfully imported.

• Basic troubleshooting information (if the import fails).

If the import failed, review the error messages in the email notification for hints, then validate the YAML file formatting and structure against Red Canary's specifications.

YAML File Schema

The automation import/export YAML file uses the following schema:

---
triggers:
- name: string
  trigger: string
  sort_order: integer # optional
  trigger_type: string
  playbooks:
  - integer # can be multiple
  conditions:
  - model: string
    attribute_name: string
    matcher: string
    value: string
    nested_attribute: string # optional
playbooks:
- id: integer
  name: string
  description: string # optional
  actions: # can be multiple
  - type: string
    row_order: integer # optional
    data: hash
    secure_data: hash # optional
    async: boolean
    resource_type: string # optional
    resource_id: integer # optional
    should_run_if_playbook_successful: boolean

FAQ