POST /flows

アクティブなフローの設定を行います。

必要となる権限: flows.write

Headers

Node-RED-Deployment-Typeヘッダは デプロイの方法を決定するために使用されます。

• full - 新しい設定が開始される前に、すべての既存のノードが停止されます。 これはヘッダが指定されていない場合のデフォルトの挙動です。
• nodes - 新しい設定が適用される前に、 変更されたノードだけが停止されます。
• flows - 新しい設定が適用される前に、 変更されたノードを含むフローだけが停止されます。
• reload - フローが再読込され、すべてのノードが再開されます。 (Node-RED 0.12.2 から)

Arguments

リクエストボディのフォーマットは Node-RED API バージョンによって決まります。

v1 - ノードオブジェクトの配列

[
  {
    "type": "tab",
    "id": "396c2376.c693dc",
    "label": "Sheet 1"
  }
]

v2 - フローレスポンスオブジェクト

rev プロパティが指定されている場合は、 GET /flows によって取得できるリビジョンと一致すべきです。

{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1"
      }
    ]
}

ノードクレデンシャルを設定する

リクエストでクレデンシャルを提示するには2つの方法があります。 flows配列のノードオブジェクトはcredentialsプロパティを持っており、 このプロパティはノードのクレデンシャルを保持しています。

また、トップレベルオブジェクトもcredentialsプロパティを持っており、 各々のノードのクレデンシャルまたは完全に暗号化された一連のクレデンシャルを持ちます。

インラインノードクレデンシャル :

{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1",
        "credentials": {
            "user": "my-username",
            "pass": "my-password"
        }
      }
    ]
}

分割されたノードクレデンシャル :

{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1"
      }
    ],
    "credentials": {
        "396c2376.c693dc": {
            "user": "my-username",
            "pass": "my-password"
        }
    }
}

暗号化されたノードクレデンシャル:

{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1"
      }
    ],
    "credentials": {
        "$": "beea417990012379ca6d4116bd1fda5bOWbwy7UnQvccxAEH1V1pSEETTfSNerYGvP4Aai6RT/DNpnjCCP/fdzildzlJhFjYcRKdO1Q="
    }
}

}

Response

v1 APIが使用される場合、成功時はレスポンスボディを含みません。

v2 APIの場合は、リクエストは rev を含まなければならず、 最新の rev の値でなければなりません。 この値がランタイムのアクティブなフローの rev の値と一致すれば、リクエストは成功します。

この値が一致しない場合、ランタイムはより新しいバージョンのフローを使用していることを表し、 リクエストはステータスコード 409 とともに拒否されます。 これによりAPI呼び出し元は、差分を解消させリクエストを再送信できます。

API呼び出し元が強制的にデプロイを行いたい場合は、 rev プロパティを省略してリクエストします。

リクエストが成功すると、レスポンスには新しい rev の値を返します。

{
    "rev": "def-456",
}

注意: rev プロパティは文字列です。 フォーマット上、他の制約はありません。