API Reference

Update a pipeline

patch
https://api.instill-ai.com/v1beta/namespaces//pipelines/

Udpates a pipeline, accessing it by its resource name, which is defined by the parent namespace and the ID of the pipeline. The authenticated namespace must be the parent of the pipeline in order to modify it.

In REST requests, only the supplied pipeline fields will be taken into account when updating the resource.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Namespace ID

string
required

Pipeline ID

Body Params

The pipeline fields that will replace the existing ones.

string

Pipeline resource ID (used in name as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

string

Pipeline description.

recipe
object
required

Recipe describes the components of a Pipeline and how they are connected.

sharing
object

Sharing contains the information to share a resource with other users.

For more information, see Share Pipelines.

metadata
object

Metadata holds console-related data such as the pipeline builder layout.

string

README holds the pipeline documentation.

tags
array of strings

Tags.

tags
string

Recipe in YAML format describes the components of a pipeline and how they are connected.

string

A link to the source code of the pipeline (e.g. to a GitHub repository).

string

A link to any extra information.

string

License under which the pipeline is distributed.

string

Pipeline profile image in base64 format.

Responses

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago