创建

POST

{{URL}}/env/v1/create

Env 环境变量

请求参数

Authorization

在 header 添加参数

api-token

示例：

api-token: ********************

Body 参数application/json

category

enum<string>

变量类型

可选

枚举值:

ordinarycompositecomposite_value

compositeId

string

可选

创建复合变量的值时需要指定此参数为复合变量(组)的唯一标识

data

可选

One of

object

array [object {8}]

type

string

变量名称

必需

description

string

描述

可选

tag_list

string

可选

标签，label名称 | color颜色(HEX)

group_id

number

可选

envs_group 表 id 字段关联记录，为0时表示普通变量

remark

string

备注

可选

value

string

值

可选

sort

number

可选

在分页中的位置序号（正整数），默认按照先后顺序递增

enable

enum<number>

可选

状态 1 启用 | 0 禁用

枚举值:

示例

{
    "category": "ordinary",
    "compositeId": "string",
    "data": {
        "type": "string",
        "description": "string",
        "tag_list": "string",
        "group_id": 0,
        "remark": "string",
        "value": "string",
        "sort": 0,
        "enable": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://localhost:5678/api/open/env/v1/create' \
--header 'Content-Type: application/json' \
--header 'api-token;' \
--data-raw '{
    "category": "ordinary",
    "compositeId": "string",
    "data": {
        "type": "string",
        "description": "string",
        "tag_list": "string",
        "group_id": 0,
        "remark": "string",
        "value": "string",
        "sort": 0,
        "enable": 0
    }
}'

返回响应

🟢200成功

application/json

响应

Body

可选

One of

EnvData

EnvGroupData

object

number

唯一标识

可选

type

string

变量名称

可选

description

string

描述

可选

tag_list

string

可选

标签，label名称 | color颜色(HEX)

enable

enum<number>

可选

状态 1 启用 | 0 禁用

枚举值:

group_id

number

可选

envs_group 表 id 字段关联记录，为0时表示普通变量

remark

string

备注

可选

value

string

值

可选

sort

number

可选

在分页中的位置序号（正整数），默认按照先后顺序递增

示例

{
    "id": 0,
    "type": "string",
    "description": "string",
    "tag_list": "string",
    "enable": 0,
    "group_id": 0,
    "remark": "string",
    "value": "string",
    "sort": 0
}

精准查询

更新