Recipes

Create Forge recipe run

Run a Forge recipe on specified servers.

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

post/forge-recipes/{forgeRecipe}/runs

Request

Base URL
https://forge.laravel.com/api
Auth
OAuth 2
Authorization codehttps://forge.laravel.com/oauth/authorize
Token URLhttps://forge.laravel.com/oauth/token
Scopesrecipe:view
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/forge-recipes/:forgeRecipe/runs/post.ts
A function with typed inputs. Its response is checked against the schema.

forgeRecipeinteger required

The forge recipe ID

emailboolean

Whether to send an email notification when the recipe has completed.

serversinteger[] required

The servers on which to run the recipe on.

{
  "email": true,
  "servers": [
    1,
    2,
    3
  ]
}

Recipe run accepted

No recorded changes to this operation across all 1 revision of this API.