Skip to content

taipy.rest.api.views.PipelineResource

Bases: Resource

Single object resource

get
  • api summary: Get a pipeline. description: | 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: - in: path name: pipeline_id schema: type: string description: The identifier of the pipeline. responses: 200: content: application/json: schema: type: object properties: pipeline: PipelineSchema 404: description: No pipeline has the pipeline_id identifier.

delete
  • api summary: Delete a pipeline. description: | 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: - in: path name: pipeline_id schema: type: string description: The identifier of the pipeline. responses: 200: content: application/json: schema: type: object properties: message: type: string description: Status message. 404: description: No pipeline has the pipeline_id identifier.