Pipelines

List_pipelines

GET/api/pipelines

Authorization

api_key

X-API-Key<token>

In: header

Query Parameters

tenant_id*string

Formatuuid

status?null|

Response Body

`application/json`

curl -X GET "https://example.com/api/pipelines?tenant_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "pipelines": [    {      "created_at": "2019-08-24T14:15:22Z",      "definition": null,      "deployed_at": "2019-08-24T14:15:22Z",      "deployed_version": 0,      "name": "string",      "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",      "status": "Active",      "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",      "updated_at": "2019-08-24T14:15:22Z",      "working_set_id": "a79ceddf-c6d9-475d-a02a-5558094c8980",      "working_version": 0    }  ]}

Create_pipeline

POST/api/pipelines

Authorization

api_key

X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines" \  -H "Content-Type: application/json" \  -d '{}'

{  "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0"}

Get_pipeline

GET/api/pipelines/{pipeline_id}

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "created_at": "2019-08-24T14:15:22Z",  "definition": null,  "deployed_at": "2019-08-24T14:15:22Z",  "deployed_version": 0,  "name": "string",  "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",  "status": "Active",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z",  "working_set_id": "a79ceddf-c6d9-475d-a02a-5558094c8980",  "working_version": 0}

Delete_pipeline

DELETE/api/pipelines/{pipeline_id}

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Deploy_pipeline

POST/api/pipelines/{pipeline_id}/deploy

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/deploy"

Empty

Disable_pipeline

POST/api/pipelines/{pipeline_id}/disable

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/disable"

Empty

Enable_pipeline

POST/api/pipelines/{pipeline_id}/enable

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/enable"

Empty

Rename_pipeline

POST/api/pipelines/{pipeline_id}/rename

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/rename" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Empty

Trigger_pipeline

POST/api/pipelines/{pipeline_id}/trigger

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

run?array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/trigger" \  -H "Content-Type: application/json" \  -d '{}'

{  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"}

Update_definition

POST/api/pipelines/{pipeline_id}/update-definition

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

pipeline_id*string

Pipeline ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

definition*unknown

Response Body

`application/json`

curl -X POST "https://example.com/api/pipelines/497f6eca-6276-4993-bfeb-53cbbbba6f08/update-definition" \  -H "Content-Type: application/json" \  -d '{    "definition": null  }'

Empty

200application/json

201application/json

400application/json

409application/json

200application/json

404application/json

204

404application/json

204

404application/json

422application/json

204

404application/json

409application/json

204

404application/json

409application/json

204

404application/json

409application/json

201application/json

404application/json

422application/json

204

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`