Recipes

Update recipe

Update a recipe in the organization.

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

put/orgs/{organization}/recipes/{recipe}

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:manage
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/orgs/:organization/recipes/:recipe/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

The organization slug

recipeinteger required

The recipe ID

Request body

namestring

user'root' | 'forge'

scriptstring

Response

RecipeResource

Example response

{
  "data": {
    "attributes": {
      "name": "Install Security tooling",
      "script": "apt-get install -y my-custom-tooling",
      "user": "root",
      "created_at": "2025-07-29T09:00:00Z",
      "updated_at": "2025-07-30T09:00:00Z"
    }
  }
}

Changes

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