---
title: "getAutomation"
canonical: "https://support.appfire.com/space/CSOAP/526846765/getAutomation"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458401)

> Macro (details)
> 
> | **Description** | Get information for an automations specified by name or directory or both. An automation is a directory containing a 'automation.yaml' description and optional ACLI script files or related resources. |
> | --- | --- |
> | **Required Parameters** | [name](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459513) or [directory](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/527336192) |
> | **Optional Parameters** | [regex](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458942), [columns](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459679), [select](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68453905), [options](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459041), [outputType](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459055), [file](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455055), [append](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454814), [encoding](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458746), [channel](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68452742) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455033/Action+Types#ActionTypes-Get) |
> | **Category** | [Automations](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455044/Action+Categories#ActionCategories-Automations) |
> | **Output Formats** |  |
> | **Replacement Variables** | automationName, automationDirectory, automationLocation |
> | **Hosting** |  |
> | **Since Version** | 11.1 |
> | **Examples** |  |

## Related How To's

> Macro (cql-query)