Paths for pipeline
Entry points that interact with Pipeline
entities.
/api/v1/pipelines
¶
GET¶
Return an array of all pipelines.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_READER role.
Code example:
curl -X GET http://localhost:5000/api/v1/pipelines
Responses
-
200
Status:OK
Name Type results [ PipelineSchema
]
POST¶
Create a pipeline from its config_id. If the config does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_EDITOR role.
Code example:
curl -X POST http://localhost:5000/api/v1/pipelines?config_id=my_pipeline_config
Parameters
Name | Type | Required | Description |
---|---|---|---|
config_id | string | Yes | The identifier of the pipeline configuration. |
Responses
-
201
Status:Created
Name Type message string pipeline PipelineSchema
/api/v1/pipelines/submit/{pipeline_id}
¶
POST¶
Execute a pipeline from pipeline_id. If the pipeline does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), This endpoint requires TAIPY_EXECUTOR role.
Code example:
curl -X POST http://localhost:5000/api/v1/pipelines/submit/PIPELINE_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
pipeline_id | string | Yes | - |
Responses
-
204
Status:No Content
Name Type message string pipeline PipelineSchema
-
404
Status:Not Found
No pipeline has the pipeline_id identifier.
/api/v1/pipelines/{pipeline_id}
¶
DELETE¶
Delete a pipeline. If the pipeline does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_EDITOR role.
Code example:
curl -X DELETE http://localhost:5000/api/v1/pipelines/PIPELINE_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
pipeline_id | string | Yes | The identifier of the pipeline. |
Responses
-
200
Status:OK
Name Type message string -
404
Status:Not Found
No pipeline has the pipeline_id identifier.
GET¶
Return a single pipeline by pipeline_id. If the pipeline does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_READER role.
Code example:
curl -X GET http://localhost:5000/api/v1/pipelines/PIPELINE_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
pipeline_id | string | Yes | The identifier of the pipeline. |
Responses
-
200
Status:OK
Name Type pipeline PipelineSchema
-
404
Status:Not Found
No pipeline has the pipeline_id identifier.