> For the complete documentation index, see [llms.txt](https://docs.getmesa.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getmesa.com/for-developers/admin-api.md).

# Admin API

The MESA Admin API allows you to programmatically interact with MESA. All requests must include your API key. To get your key, install the [MESA CLI](https://docs.getmesa.com/for-developers/command-line-interface.md) and run `mesa auth login`. Your key is saved to `~/.mesa/config.yml`.

<table><thead><tr><th width="151">Key</th><th width="451">Value</th></tr></thead><tbody><tr><td>{url}</td><td>https://api.getmesa.com/v1</td></tr><tr><td>{uuid}</td><td>Your store’s unique identifier: {{uuid}}.myshopify.com</td></tr></tbody></table>

## Workflows

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations/{automation\_key}.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations/{automation\_key}.json" method="delete" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Connections

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/credentials.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/credentials.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/credentials/{credential\_key}.json" method="put" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/credentials/{credential\_key}.json" method="delete" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Storage

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/storage.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/storage.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/storage/{storage\_key}.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/storage/{storage\_key}.json" method="put" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/storage/{storage\_key}.json" method="delete" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Scripts

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/scripts.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/scripts.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/scripts.json" method="delete" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Testing

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation\_key}/triggers/{trigger\_key}/test.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Tasks

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/tasks/{task\_id}/replay.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Templates

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/templates/install.json" method="post" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}

## Logs

{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/logs.json" method="get" %}
[mesa-admin.openapi.json](https://3425906282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1H6u1HQc3Iew7ATmmiCi%2Fuploads%2Fgit-blob-f1c2d3bea3569727079ea74e76d443c1d89e02b5%2Fmesa-admin.openapi.json?alt=media)
{% endopenapi %}
