---
title: "Create recipe run"
method: POST
path: "/orgs/{organization}/recipes/{recipe}/runs"
tags: ["Recipes"]
---

# Create recipe run

`POST /orgs/{organization}/recipes/{recipe}/runs`

## Request

- Base URL: `https://forge.laravel.com/api`
- URL: `https://forge.laravel.com/api/orgs/{organization}/recipes/{recipe}/runs`
- Auth: OAuth 2
  - Authorization code: `https://forge.laravel.com/oauth/authorize`
  - Token URL: `https://forge.laravel.com/oauth/token` scopes: `recipe:view`
- TypeScript: <https://skmtc.dev/mfullbrook/apis/forge/docs/orgs/:organization/recipes/:recipe/runs/post.ts> (a function with typed inputs; its response is checked against the schema)

Run a given recipe on a list of servers.

Processing mode: <small><code>async</code></small>

## Path parameters

- `organization` string, required
- `recipe` integer, required

## Request body

- RunRecipeRequest
  - `email` boolean: Whether to send an email notification when the recipe has completed.
  - `servers` integer[], required: The servers on which to run the recipe on.

## Response `202`

Recipe run accepted

## Other responses

- `403`: Authorization error
- `404`: Not found
- `422`: Validation error

---

[API](https://skmtc.dev/mfullbrook/apis/forge.md) - [All operations](https://skmtc.dev/mfullbrook/apis/forge/llms.txt) - [OpenAPI document](https://skmtc.dev/mfullbrook/apis/forge/revisions/24ad66d99f93?raw)