Pipelines

Pipeline configuration management operations

---

List all pipelines

GET

/api/v1/pipelines

Retrieve a list of all configured pipelines

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Query Parameters

sort_by

Field to sort by

Typestring

Default"created_at"

sort_order

Sort order

Typestring

Valid values

"ASC""DESC"

Default"DESC"

Responses

Successful response

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

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

sort_by

sort_order

Samples

---

Create a new pipeline

POST

/api/v1/pipelines

Create and configure a new pipeline

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Request Body

application/json

{

"name": "string",

"config": {

}

}

Responses

Pipeline created successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"uuid": "string"

}

}

POST

/api/v1/pipelines

Playground

Server

Authorization

ApiKeyAuth

Body

Samples

---

Get pipeline metadata

GET

/api/v1/pipelines/_/metadata

Retrieve metadata and configuration options for pipelines

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Responses

Successful response

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

"configs": {

}

}

}

GET

/api/v1/pipelines/_/metadata

Playground

Server

Authorization

ApiKeyAuth

Samples

---

Get a specific pipeline

GET

/api/v1/pipelines/{pipeline_uuid}

Retrieve details of a specific pipeline

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

pipeline_uuid*

Typestring

Required

Format"uuid"

Responses

Successful response

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}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

pipeline_uuid*

Samples

---

Update a pipeline

PUT

/api/v1/pipelines/{pipeline_uuid}

Update the configuration of an existing pipeline

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

pipeline_uuid*

Typestring

Required

Format"uuid"

Request Body

application/json

{

"name": "string",

"config": {

}

}

Responses

Pipeline updated successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

PUT

/api/v1/pipelines/{pipeline_uuid}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

pipeline_uuid*

Body

Samples

---

Delete a pipeline

DELETE

/api/v1/pipelines/{pipeline_uuid}

Remove a pipeline from the system

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

pipeline_uuid*

Typestring

Required

Format"uuid"

Responses

Pipeline deleted successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

DELETE

/api/v1/pipelines/{pipeline_uuid}

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

pipeline_uuid*

Samples

---

Get pipeline extensions

GET

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

Retrieve extensions and plugins configured for a pipeline

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

pipeline_uuid*

Typestring

Required

Format"uuid"

Responses

Successful response

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

GET

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

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

pipeline_uuid*

Samples

---

Update pipeline extensions

PUT

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

Update the extensions configuration for a pipeline

Authorizations

ApiKeyAuth

API Key authentication using X-API-Key header.
Example: X-API-Key: lbk_your_api_key_here

TypeAPI Key (header: X-API-Key)

or

BearerAuth

Bearer token authentication. Can be either a user JWT token or an API key.
Example: Authorization: Bearer <token_or_key>

TypeHTTP (bearer)

Parameters

Path Parameters

pipeline_uuid*

Typestring

Required

Format"uuid"

Request Body

application/json

{

}

Responses

Extensions updated successfully

Content-Type

application/json

{

"code": 0,

"msg": "ok",

"data": {

}

}

PUT

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

Playground

Server

Authorization

ApiKeyAuth

Variables

Key

Value

pipeline_uuid*

Body

Samples

---

Powered by VitePress OpenAPI