Retire Pipeline Template

POST

/v1/pipelines/templates/{pipeline_template_id}:retire

curl --request POST \
  --url https://junction-api.qualiastudios.dev/v1/pipelines/templates/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0:retire \
  --header 'X-API-Key: <X-API-Key>'

No new run starts from the template and no template pins it anew. Runs that started keep their snapshot; its history stays readable.

Authorizations

• ApiKey
• Bearer

Parameters

Path Parameters

pipeline_template_id

required

string format: uuid

Responses

200

Successful Response

Media type application/json

RetiredTemplate

object

pipeline_template_id

required

string format: uuid

retired

boolean

default: true

Example

{
  "retired": true
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

403

Missing capability on the workspace

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

404

Template not found

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Array<object>

ValidationError

object

loc

required

Location

Array<string | integer>

msg

required

Message

string

type

required

Error Type

string

input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}