Update Craft Function

post

https://api.karte.io/v2beta/craft/function/update

Craft function更新のリクエストを送信します。

Required Scope

APIの実行に必要なScopeです。

beta.craft.function.update

Required Role

管理画面でScopeを追加する際に必要な権限です。

Craft > Craft 設定の編集

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

ファンクションIDです。管理画面のURLに含まれるIDです。

description

string

required

ファンクションの説明

code

string

required

ファンクションのJavascriptコード

variables

array of objects

required

ファンクションの変数

variables*

packages

object

required

ファンクションのモジュール

active

boolean

ファンクションの有効・無効

kickHookV2

boolean

Defaults to false

この操作でHook V2のトリガーを発火するかどうか。（参照）

refreshDependencies

boolean

デプロイ時にパッケージ依存関係を更新するかどうか。モジュール（packages）に変更がある場合はこの値に関わらずパッケージ依存関係が自動的に再解決されます。

minReleaseAge

number

≥ 0

パッケージ最小公開日数（日数）。デフォルトは5日。npm公開から指定日数未満のパッケージバージョンをインストール対象から除外します。最近公開されたバージョンを使用する場合は0を指定してください。

skipRecreateIfFailed

boolean

FAILED状態のHTTPファンクションを更新する際、ファンクションを再作成せずに更新するかどうか。
trueの場合、既存のファンクションを削除せずに更新を試みます。HTTPファンクション以外では指定できません。
未指定またはfalseの場合、FAILED時は従来どおり再作成します。
詳細: https://craft.developers.karte.io/craft-functions/edit-craft-funcitons/#デプロイに失敗した場合

Headers

x-karte-api

string

今後利用する可能性のある予約語です。現在は設定不要です。

Response

Language

Credentials

Bearer

URL

Loading…

Response

Choose an example:

application/json

200A successful response.