Update Parameter

PUT /pipelines/update-parameter

Update a pipeline parameter

Request

Headers

An API Key is required to access this endpoint.

NameValue

x-api-key

your_api_key

Body

NameTypeDescription

id

string

Unique ID for the pipeline.

parameter

Parameter object.

Parameter

NameTypeDescription

id

string

Unique ID for the parameter.

name

string

Name of the parameter.

type

enum

Supported enums: file string

Example

{
  "id": "6901b859-fe94-4c3c-a826-a4d484f309a6",
  "type": "file"
}

Response

The API returns the response in JSON format.

Each response includes a success boolean and the updated parameter.

Example

{
  "parameter": {
    "id": "6901b859-fe94-4c3c-a826-a4d484f309a6",
    "name": "review",
    "type": "file"
  },
  "success": true
}

Last updated