Skip to main content
POST
/
forge-recipes
/
{forgeRecipe}
/
runs
Create Forge recipe run
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/forge-recipes/{forgeRecipe}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => null,
    'servers' => [
        1,
        2,
        3
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
This response does not have an example.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

forgeRecipe
integer
required

The forge recipe ID

Body

application/json
servers
integer[]
required

The servers on which to run the recipe on.

Example:
[1, 2, 3]
email
boolean

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

Example:

true

Response

Recipe run accepted

I