バックエンドの Bastion API¶
バックエンドの Bastion API 解説書
Backends¶
-
GET
/bastion/backends
¶ バックエンドのリストを取得する
応答 JSON オブジェクト: - [key].id (string) – バックエンド ID
- [key].type (string) – バックエンドタイプ。
- [key].config[key].id (string) – 変数 ID。
- [key].config[key].editable (boolean) – 変数が編集可能かどうか。
- [key].config[key].asArgument (boolean) – 変数を引数として terraform に渡すか、設定ファイルに渡すか。
- [key].config[key].protected (boolean) – 変数を GUI のパスワードとして表示するかどうか。
- [key].config[key].value (string) – 変数の値。
応答例 :
{ "default": { "id": "default", "type": "consul", "config": { "address": { "id": "address", "editable": false, "asArgument": false, "protected": false, "value": "127.0.0.1:8500" }, "path": { "id": "path", "editable": false, "asArgument": false, "protected": false, "value": "bastion/terraform/states/{{.clusterID}}/{{.clusterUUID}}/tfstate" } } } }
-
GET
/bastion/backend/{backendID}
¶ バックエンドを取得する
パラメータ: - backendID – バックエンド ID
応答 JSON オブジェクト: - id (string) – バックエンド ID
- type (string) – バックエンドタイプ。
- config[key].id (string) – 変数 ID。
- config[key].editable (boolean) – 変数が編集可能かどうか。
- config[key].asArgument (boolean) – 変数を引数として terraform に渡すか、設定ファイルに渡すか。
- config[key].protected (boolean) – 変数を GUI のパスワードとして表示するかどうか。
- config[key].value (string) – 変数の値。
応答例 :
{ "id": "default", "type": "consul", "config": { "address": { "id": "address", "editable": false, "asArgument": false, "protected": false, "value": "127.0.0.1:8500" }, "path": { "id": "path", "editable": false, "asArgument": false, "protected": false, "value": "bastion/terraform/states/{{.clusterID}}/{{.clusterUUID}}/tfstate" } } }
-
POST
/bastion/backend/{backendID}
¶ バックエンドを作成する。
パラメータ: - backendID – バックエンド ID
リクエスト JSON オブジェクト: - id (string) – バックエンド ID
- type (string) – バックエンドタイプ。
- config[key].id (string) – 変数 ID。
- config[key].editable (boolean) – 変数が編集可能かどうか。
- config[key].asArgument (boolean) – 変数を引数として terraform に渡すか、設定ファイルに渡すか。
- config[key].protected (boolean) – 変数を GUI のパスワードとして表示するかどうか。
- config[key].value (string) – 変数の値。
クエリ例 :
{ "id": "default", "type": "consul", "config": { "address": { "id": "address", "editable": false, "asArgument": false, "protected": false, "value": "127.0.0.1:8500" }, "path": { "id": "path", "editable": false, "asArgument": false, "protected": false, "value": "bastion/terraform/states/{{.clusterID}}/{{.clusterUUID}}/tfstate" } } }
-
PUT
/bastion/backend/{backendID}
¶ バックエンドを更新する。
パラメータ: - backendID – バックエンド ID
リクエスト JSON オブジェクト: - id (string) – バックエンド ID
- type (string) – バックエンドタイプ。
- config[key].id (string) – 変数 ID。
- config[key].editable (boolean) – 変数が編集可能かどうか。
- config[key].asArgument (boolean) – 変数を引数として terraform に渡すか、設定ファイルに渡すか。
- config[key].protected (boolean) – 変数を GUI のパスワードとして表示するかどうか。
- config[key].value (string) – 変数の値。
クエリ例 :
{ "id": "default", "type": "consul", "config": { "address": { "id": "address", "editable": false, "asArgument": false, "protected": false, "value": "127.0.0.1:8500" }, "path": { "id": "path", "editable": false, "asArgument": false, "protected": false, "value": "bastion/terraform/states/{{.clusterID}}/{{.clusterUUID}}/tfstate" } } }
-
DELETE
/bastion/backend/{backendID}
¶ バックエンドを削除する
パラメータ: - backendID – バックエンド ID