> ## Documentation Index
> Fetch the complete documentation index at: https://documents.trocco.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 環境グループ更新
> 環境グループを更新します。
環境グループ更新にはアカウント管理者以上の権限が必要です。
## OpenAPI
````json PATCH /api/environment_groups/{environment_group_id}
{
"openapi": "3.0.3",
"info": {
"title": "trocco APIリファレンス",
"description": "trocco APIリファレンス",
"version": "0.0.1"
},
"servers": [
{
"url": "https://trocco.io"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "users",
"description": "ユーザー",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-account-user"
}
},
{
"name": "teams",
"description": "チーム",
"externalDocs": {
"url": "https://documents.trocco.io/docs/team"
}
},
{
"name": "connections",
"description": "接続情報",
"externalDocs": {
"url": "https://documents.trocco.io/docs/connection-configurations"
}
},
{
"name": "custom_connectors",
"description": "カスタムコネクタ定義"
},
{
"name": "datamart_definitions",
"description": "データマート定義",
"externalDocs": {
"url": "https://documents.trocco.io/docs/data-mart"
}
},
{
"name": "environment_groups",
"description": "環境グループ"
},
{
"name": "environments",
"description": "環境"
},
{
"name": "jobs",
"description": "転送ジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/etl-configuration"
}
},
{
"name": "pipeline_jobs",
"description": "ワークフロージョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-workflow"
}
},
{
"name": "resource_groups",
"description": "リソースグループ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/resource-group"
}
},
{
"name": "dbt_git_repositories",
"description": "dbt Gitリポジトリ"
},
{
"name": "dbt_job_definitions",
"description": "dbtジョブ設定",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "dbt_jobs",
"description": "dbtジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "notification_destinations",
"description": "通知先",
"externalDocs": {
"url": "https://documents.trocco.io/docs/trocco-tutorial-additional-settings"
}
}
],
"externalDocs": {
"description": "trocco APIについて",
"url": "https://documents.trocco.io/docs/trocco-api"
},
"paths": {
"/api/environment_groups/{environment_group_id}": {
"patch": {
"summary": "環境グループ更新",
"description": "環境グループを更新します。
\n環境グループ更新にはアカウント管理者以上の権限が必要です。\n",
"operationId": "updateEnvironmentGroup",
"tags": [
"environment_groups"
],
"parameters": [
{
"name": "environment_group_id",
"in": "path",
"description": "環境グループID",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"description": "環境グループ名",
"type": "string",
"example": "サンプル環境グループ"
},
"memo": {
"description": "メモ",
"type": "string",
"example": "# 環境グループのメモ\n\nこの環境グループは本番環境用です。"
}
},
"required": [
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "更新した環境グループの詳細を返します。",
"content": {
"application/json": {
"schema": {
"title": "EnvironmentGroup",
"type": "object",
"properties": {
"id": {
"description": "環境グループID",
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"description": "環境グループ名",
"type": "string",
"example": "サンプル環境グループ"
},
"memo": {
"description": "メモ",
"type": "string",
"nullable": true,
"example": "# 環境グループのメモ\n\nこの環境グループは本番環境用です。"
},
"created_at": {
"description": "環境グループの作成日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
},
"updated_at": {
"description": "環境グループの更新日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
}
},
"required": [
"id",
"name",
"created_at",
"updated_at"
]
}
}
}
},
"400": {
"description": "Bad request.
\n不正なリクエストです。\n"
},
"401": {
"description": "Not authenticated or insufficient permissions.
\n環境グループ更新権限がないか、API KEYが不正です。\n"
},
"404": {
"description": "Not found.
\n指定した環境グループが存在しません。\n"
}
}
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
\nAPI KEYがabc123の場合は、Authorization: Token abc123とします。
\nAPI KEYの作成方法は、TROCCO API KEYの作成を参照ください。\n"
}
}
}
}
````