---
title: " "
sidebarTitle: prefect automations
---

# `prefect automations`



```command
prefect automations [OPTIONS] COMMAND [ARGS]...
```



<Info>
Manage automations.
</Info>








## `prefect automations ls`



```command
prefect automations ls [OPTIONS]
```



<Info>
List all automations.
</Info>








## `prefect automations inspect`



```command
prefect automations inspect [OPTIONS] [NAME]
```



<Info>
Inspect an automation.

Arguments:

    name: the name of the automation to inspect

    id: the id of the automation to inspect

    yaml: output as YAML

    json: output as JSON

Examples:

    `$ prefect automation inspect "my-automation"`

    `$ prefect automation inspect --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`

    `$ prefect automation inspect "my-automation" --yaml`

    `$ prefect automation inspect "my-automation" --output json`
    `$ prefect automation inspect "my-automation" --output yaml`
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

<ResponseField name="--yaml">
    Output as YAML
</ResponseField>

<ResponseField name="--json">
    Output as JSON
</ResponseField>

<ResponseField name="--output">
    Specify an output format. Currently supports: json, yaml
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect automations resume`



```command
prefect automations resume [OPTIONS] [NAME]
```



<Info>
Resume an automation.

Arguments:

        name: the name of the automation to resume

        id: the id of the automation to resume

Examples:

        `$ prefect automation resume "my-automation"`

        `$ prefect automation resume --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect automations enable`



```command
prefect automations enable [OPTIONS] [NAME]
```



<Info>
Resume an automation.

Arguments:

        name: the name of the automation to resume

        id: the id of the automation to resume

Examples:

        `$ prefect automation resume "my-automation"`

        `$ prefect automation resume --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect automations pause`



```command
prefect automations pause [OPTIONS] [NAME]
```



<Info>
Pause an automation.

Arguments:

        name: the name of the automation to pause

        id: the id of the automation to pause

Examples:

    `$ prefect automation pause "my-automation"`

    `$ prefect automation pause --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect automations disable`



```command
prefect automations disable [OPTIONS] [NAME]
```



<Info>
Pause an automation.

Arguments:

        name: the name of the automation to pause

        id: the id of the automation to pause

Examples:

    `$ prefect automation pause "my-automation"`

    `$ prefect automation pause --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

</Accordion>

</AccordionGroup>



## `prefect automations delete`



```command
prefect automations delete [OPTIONS] [NAME]
```



<Info>
Delete an automation.
</Info>






<AccordionGroup>


<Accordion title="Arguments" defaultOpen>
<ResponseField name="NAME" type="string">
    An automation's name
</ResponseField>
</Accordion>



<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    An automation's id
</ResponseField>

<ResponseField name="--all">
    Delete all automations
</ResponseField>

</Accordion>

</AccordionGroup>


<Note>
**Example:**

`$ prefect automation delete "my-automation"`
`$ prefect automation delete --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"`
`$ prefect automation delete --all`
</Note>




## `prefect automations create`



```command
prefect automations create [OPTIONS]
```



<Info>
Create one or more automations from a file or JSON string.
</Info>






<AccordionGroup>




<Accordion title="Options" defaultOpen>

<ResponseField name="--from-file">
    Path to YAML or JSON file containing automation(s)
</ResponseField>

<ResponseField name="--from-json">
    JSON string containing automation(s)
</ResponseField>

</Accordion>

</AccordionGroup>


<Note>
**Example:**

`$ prefect automation create --from-file automation.yaml`
`$ prefect automation create -f automation.json`
`$ prefect automation create --from-json '{"name": "my-automation", "trigger": {...}, "actions": [...]}'`
`$ prefect automation create -j '[{"name": "auto1", ...}, {"name": "auto2", ...}]'`
</Note>




## `prefect automations update`



```command
prefect automations update [OPTIONS]
```



<Info>
Update an existing automation from a file or JSON string.
</Info>






<AccordionGroup>




<Accordion title="Options" defaultOpen>

<ResponseField name="--id">
    The ID of the automation to update
</ResponseField>

<ResponseField name="--from-file">
    Path to YAML or JSON file containing the updated automation
</ResponseField>

<ResponseField name="--from-json">
    JSON string containing the updated automation
</ResponseField>

</Accordion>

</AccordionGroup>


<Note>
**Example:**

`$ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" --from-file automation.yaml`
`$ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" -f automation.json`
`$ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" --from-json '{"name": "updated-automation", "trigger": {...}, "actions": [...]}'`
</Note>

