Pipelines

Pipelines composition APIs

Get all Pipelines for the Enterprise

Returns all the Pipelines that are not deleted

Request
Security:
query Parameters
default
boolean
Enum: true false
Responses
200

Pipelines list for the Enterprise

get/v0/pipelines/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Create a new Pipeline

Create a Pipeline for the enterprise using logged in user token

Request
Security:
Request Body schema: application/json
name
required
string
description
string
is_default
boolean
Default: false
is_active
boolean
Default: true
timeout_seconds
number <int32>
Default: 86400
Responses
200

Created

400

Pipelines create error

401

Pipelines create error

post/v0/pipelines/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_default": false,
  • "is_active": true,
  • "timeout_seconds": 86400
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get a Pipeline

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Responses
200

Pipeline information

get/v0/pipelines/{pipeline_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Update a Pipeline

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Request Body schema: application/json
name
string
description
string
is_active
boolean
is_default
boolean
timeout_seconds
number <int32>
Responses
200

Updated Pipeline Information

400

Pipelines update error

401

Pipelines update error

put/v0/pipelines/{pipeline_id}/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "is_default": true,
  • "timeout_seconds": 0
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Delete a Pipeline

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Responses
200

Deleted Pipeline Information

401

Pipelines delete error

delete/v0/pipelines/{pipeline_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}