DevZero Logo
DevZero

Update Team Recipe By ID V2

Update a recipe for a team

PATCH
/v2/teams/{team_id}/recipes/{recipe_id}
/v2/teams/{team_id}/recipes/{recipe_id}

Request Body

application/jsonRequired

update team recipe body

build_new_version
Required
boolean

should the new recipe version trigger a build

Default: false

from_version
Required
string

recipe version on which this update is based

namestring

new name for a recipe

Minimum length: 1

new_launch_versionstring

new launch version for a recipe

new_recipestring

new recipe contents

Header Parameters

Authorization
Required
string

Value: "Bearer <token>"; visit the "User Settings" page in the DevZero dashboard to generate a token

Path Parameters

team_id
Required
string

ID of team

recipe_id
Required
string

ID of recipe

curl -X PATCH "https://api.devzero.io/backend/v0/v2/teams/string/recipes/string" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{
    "build_new_version": false,
    "from_version": "string",
    "name": "string",
    "new_launch_version": "string",
    "new_recipe": "string"
  }'

updated recipe

{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "string",
  "latest_recipe_summary": {
    "cpu": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "memory": "string",
    "name": "string",
    "repos": [
      "string"
    ],
    "storage": "string"
  },
  "launch_version_id": "string",
  "name": "string",
  "recipe_shell": "string",
  "recipe_versions": [
    {
      "build": {
        "build_step_checks": [
          {
            "command": "string",
            "completed_at": "string",
            "error": "string",
            "is_cached": true,
            "is_user_step": true,
            "last_updated": "string",
            "logsrv_id": "string",
            "name": "string",
            "start_time": "string",
            "status": "pending",
            "step_id": "string"
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "id": "string",
        "modified_at": "2019-08-24T14:15:22Z",
        "recipe_id": "string",
        "recipe_name": "string",
        "recipe_version_id": "string",
        "status": "Not Started",
        "team_id": "string",
        "user_id": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "id": "string",
      "recipe": "string",
      "recipe_defaults": "string",
      "team_id": "string",
      "user": {
        "default_region": "string",
        "default_region_name": "string",
        "dora_connection_ids": [
          "string"
        ],
        "dxi_onboarding_checklist": {
          "analyze_own_code": "SKIPPED",
          "development_process_bottlenecks": "SKIPPED",
          "devzero_cli": "SKIPPED",
          "github_token": "SKIPPED",
          "is_dora_repository_connected": true
        },
        "email": "user@example.com",
        "given_name": "string",
        "id": "string",
        "linked_vcss": [
          {
            "link_metadata": "string",
            "vsc_uri": "string"
          }
        ],
        "onboarding_checklist": {
          "has_completed_onboarding": true,
          "has_completed_onboarding_checklist": true,
          "has_completed_recipe_quick_starters": true,
          "has_created_recipe": true,
          "has_dismissed_quickstart": true,
          "has_dismissed_recipe_callout": true,
          "has_forked_quickstart": true,
          "has_launched_workspace": true,
          "has_seen_onboarding_recipe_modal": true,
          "onboarding_path": "undefined"
        },
        "sub": "string",
        "teams": [
          {
            "is_owner": true,
            "name": "string",
            "permissions": "string",
            "team_id": "string",
            "user_id": "string"
          }
        ],
        "timezone": "string",
        "user_scoped_recipe": "string"
      }
    }
  ],
  "team_id": "string",
  "user": {
    "default_region": "string",
    "default_region_name": "string",
    "dora_connection_ids": [
      "string"
    ],
    "dxi_onboarding_checklist": {
      "analyze_own_code": "SKIPPED",
      "development_process_bottlenecks": "SKIPPED",
      "devzero_cli": "SKIPPED",
      "github_token": "SKIPPED",
      "is_dora_repository_connected": true
    },
    "email": "user@example.com",
    "given_name": "string",
    "id": "string",
    "linked_vcss": [
      {
        "link_metadata": "string",
        "vsc_uri": "string"
      }
    ],
    "onboarding_checklist": {
      "has_completed_onboarding": true,
      "has_completed_onboarding_checklist": true,
      "has_completed_recipe_quick_starters": true,
      "has_created_recipe": true,
      "has_dismissed_quickstart": true,
      "has_dismissed_recipe_callout": true,
      "has_forked_quickstart": true,
      "has_launched_workspace": true,
      "has_seen_onboarding_recipe_modal": true,
      "onboarding_path": "undefined"
    },
    "sub": "string",
    "teams": [
      {
        "is_owner": true,
        "name": "string",
        "permissions": "string",
        "team_id": "string",
        "user_id": "string"
      }
    ],
    "timezone": "string",
    "user_scoped_recipe": "string"
  }
}

Previous

Update a network PUT

Next

Update a secret for a team PUT