a13nDocs

更新模板

PATCH/api/v1/environment-templates/{template_id}

认证与授权

认证与授权Bearer <token>

工作空间 API 密钥(a13n_...)

传递位置: header

路径参数

template_id*Template Id

请求头参数

If-Match?|

资源 ETag:当前视图的 "{id}:{version}",模型为 "{key}:{version}"

X-Workspace-ID?|

登录会话作用的工作空间 ID,登录会话必须提供。API 密钥作用于自身工作空间,无需提供;禁止指定其他工作空间。

请求体

application/json

TypeScript 类型定义

在 TypeScript 中使用 request body 类型。

省略字段保持不变;description: null 清除描述。

新 provider 或 recipe 需要 provider 上的 write 权限,仅影响后续创建环境;已有环境保留构建时配置,空闲策略应用于全部环境。enabled: false 拒绝新环境,包括已预留但未创建的环境;已创建环境继续可用。

响应体

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/environment-templates/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "config": {    "delete_after_seconds": 60,    "recipe": {      "property1": null,      "property2": null    },    "stop_after_seconds": 1800  },  "created_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "description": "string",  "enabled": true,  "id": "string",  "labels": {    "property1": "string",    "property2": "string"  },  "name": "string",  "organization_id": "string",  "provider_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "updated_by_id": "string",  "version": 0,  "workspace_id": "string"}