流水线

流水线配置管理操作

---

列出所有流水线

GET

/api/v1/pipelines

获取所有已配置的流水线列表

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

查询参数

sort_by

排序字段

类型string

默认"created_at"

sort_order

排序顺序

类型string

有效值

"ASC""DESC"

默认"DESC"

响应

成功响应

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"pipelines": [

{

"uuid": "string",

"name": "string",

"config": {

},

"is_default": true,

"created_at": "string",

"updated_at": "string"

}

]

}

}

GET

/api/v1/pipelines

试验场

服务器

授权

ApiKeyAuth

变量

键

值

sort_by

sort_order

示例

---

创建新的流水线

POST

/api/v1/pipelines

创建并配置一个新的流水线

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

请求体

application/json

{

"name": "string",

"config": {

}

}

响应

流水线创建成功

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"uuid": "string"

}

}

POST

/api/v1/pipelines

试验场

服务器

授权

ApiKeyAuth

主体

示例

---

获取流水线元数据

GET

/api/v1/pipelines/_/metadata

获取流水线的元数据和配置选项

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

响应

成功响应

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"configs": {

}

}

}

GET

/api/v1/pipelines/_/metadata

试验场

服务器

授权

ApiKeyAuth

示例

---

获取指定的流水线

GET

/api/v1/pipelines/{pipeline_uuid}

获取指定流水线的详细信息

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

pipeline_uuid*

类型string

必填

格式"uuid"

响应

成功响应

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"pipeline": {

"uuid": "string",

"name": "string",

"config": {

},

"is_default": true,

"created_at": "string",

"updated_at": "string"

}

}

}

GET

/api/v1/pipelines/{pipeline_uuid}

试验场

服务器

授权

ApiKeyAuth

变量

键

值

pipeline_uuid*

示例

---

更新流水线

PUT

/api/v1/pipelines/{pipeline_uuid}

更新现有流水线的配置

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

pipeline_uuid*

类型string

必填

格式"uuid"

请求体

application/json

{

"name": "string",

"config": {

}

}

响应

流水线更新成功

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

PUT

/api/v1/pipelines/{pipeline_uuid}

试验场

服务器

授权

ApiKeyAuth

变量

键

值

pipeline_uuid*

主体

示例

---

删除流水线

DELETE

/api/v1/pipelines/{pipeline_uuid}

从系统中删除一个流水线

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

pipeline_uuid*

类型string

必填

格式"uuid"

响应

流水线删除成功

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

DELETE

/api/v1/pipelines/{pipeline_uuid}

试验场

服务器

授权

ApiKeyAuth

变量

键

值

pipeline_uuid*

示例

---

获取流水线扩展

GET

/api/v1/pipelines/{pipeline_uuid}/extensions

获取流水线配置的扩展和插件

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

pipeline_uuid*

类型string

必填

格式"uuid"

响应

成功响应

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

GET

/api/v1/pipelines/{pipeline_uuid}/extensions

试验场

服务器

授权

ApiKeyAuth

变量

键

值

pipeline_uuid*

示例

---

更新流水线扩展

PUT

/api/v1/pipelines/{pipeline_uuid}/extensions

更新流水线的扩展配置

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例：X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

或

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例：Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

pipeline_uuid*

类型string

必填

格式"uuid"

请求体

application/json

{

}

响应

扩展更新成功

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

PUT

/api/v1/pipelines/{pipeline_uuid}/extensions

试验场

服务器

授权

ApiKeyAuth

变量

键

值

pipeline_uuid*

主体

示例

---

技术支持 VitePress OpenAPI